Added alternate syntax to Insider plugins example (#3783)

* Add warning about merging sections between files

* Use full example with alternative syntax

* Revert accidentally commited changes

* Revert another accidental commit
This commit is contained in:
Chris White 2022-04-06 11:45:44 -07:00 committed by GitHub
parent 8264e338fb
commit dd2268f7ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -185,4 +185,26 @@ pipeline), you can build your documentation project with the following lines:
mkdocs build --config-file mkdocs.insiders.yml
```
!!! warning "Alternative syntax"
If you plan to split `plugins` or `markdown_extensions` between the two files, you must use
alternative key / value syntax for these sections. The above example would then look like:
=== ":octicons-file-code-16: mkdocs.insiders.yml"
``` yaml
INHERIT: mkdocs.yml
plugins:
social: {}
```
=== ":octicons-file-code-16: mkdocs.yml"
``` yaml
# Additional configuration above
plugins:
search: {}
tags: {}
```
[configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance