From dd2268f7acdb1b885b90d32648bbecc9b5cd2261 Mon Sep 17 00:00:00 2001 From: Chris White Date: Wed, 6 Apr 2022 11:45:44 -0700 Subject: [PATCH] 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 --- docs/insiders/getting-started.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/insiders/getting-started.md b/docs/insiders/getting-started.md index 895688cc85d..fbeb0ab827f 100644 --- a/docs/insiders/getting-started.md +++ b/docs/insiders/getting-started.md @@ -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