From 52adc006ba4e1d0177f845b020a676386418ab3d Mon Sep 17 00:00:00 2001 From: squidfunk Date: Wed, 6 Apr 2022 20:59:11 +0200 Subject: [PATCH] Documentation --- docs/insiders/getting-started.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/insiders/getting-started.md b/docs/insiders/getting-started.md index fbeb0ab82..b7cb4468a 100644 --- a/docs/insiders/getting-started.md +++ b/docs/insiders/getting-started.md @@ -185,10 +185,13 @@ 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: +!!! tip "Sharing plugin and extension configuration" + + If you want to share `plugins` or `markdown_extensions` between both + configuration files `mkdocs.insiders.yml` and `mkdocs.yml`, you can use + the alternative key-value syntax in both files. The above example would + then look like: + === ":octicons-file-code-16: mkdocs.insiders.yml" ``` yaml