Skip to content

Commit 52adc00

Browse files
committed
Documentation
1 parent dd2268f commit 52adc00

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

Diff for: docs/insiders/getting-started.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -185,10 +185,13 @@ pipeline), you can build your documentation project with the following lines:
185185
mkdocs build --config-file mkdocs.insiders.yml
186186
```
187187

188-
!!! warning "Alternative syntax"
189-
190-
If you plan to split `plugins` or `markdown_extensions` between the two files, you must use
191-
alternative key / value syntax for these sections. The above example would then look like:
188+
!!! tip "Sharing plugin and extension configuration"
189+
190+
If you want to share `plugins` or `markdown_extensions` between both
191+
configuration files `mkdocs.insiders.yml` and `mkdocs.yml`, you can use
192+
the alternative key-value syntax in both files. The above example would
193+
then look like:
194+
192195
=== ":octicons-file-code-16: mkdocs.insiders.yml"
193196

194197
``` yaml

0 commit comments

Comments
 (0)