OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2022-07-12 17:54:42 +02:00
parent 9488affa87
commit 7cb9d7b2b9
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/insiders/index.md
View File

@ -405,20 +405,19 @@ can be used by all users.
### Compatibility ### Compatibility
_We're running an open source project and want to make sure that users can _We're running an open source project and want to allow outside collaborators
change and build the documentation without having access to Insiders. Is this to run and build our documentation without having access to Insiders. Is this
still possible?_ still possible?_
Yes. Insiders is compatible with Material for MkDocs. Almost all new features Yes. Insiders is compatible with Material for MkDocs. Almost all new features
are implemented behind feature flags; almost all configuration changes are and configuration options are either backward-compatible or implemented behind
backward-compatible. This means that developers will be able to build the feature flags. This means that developers are able to build the documentation
documentation locally with Material for MkDocs and when they push their changes, locally with Material for MkDocs and when they push their changes, it can be
it can be built with Insiders (e.g. as part of GitHub Actions). built with Insiders (e.g. as part of GitHub Actions).
When using built-in plugins that are solely available via Insiders, it might be When using built-in plugins that are exclusive to Insiders, it's recommended
necessary to split the `mkdocs.yml` configuration into a base configuration, and to split configuration into a base `mkdocs.yml` and one with plugin overrides
one with plugin overrides. Note that this is a limitation of MkDocs, which can via [configuration inheritance].
be mitigated by using [configuration inheritance].
See the [getting started guide] for more information. See the [getting started guide] for more information.