From 51f56d9639cf5d3f887dd21cfb8c4c3e41c8eb2f Mon Sep 17 00:00:00 2001 From: Chris White Date: Fri, 1 Apr 2022 15:54:22 -0700 Subject: [PATCH] Add warning about merging sections between files --- docs/insiders/getting-started.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/insiders/getting-started.md b/docs/insiders/getting-started.md index 895688cc85d..82241a3a47b 100644 --- a/docs/insiders/getting-started.md +++ b/docs/insiders/getting-started.md @@ -185,4 +185,17 @@ 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 insiders file would then look like: + ``` yaml + INHERIT: mkdocs.yml + plugins: + search: {} + social: {} + tags: {} + ``` + + [configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance