Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-24 07:30:12 +01:00
Code Issues Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2022-04-06 20:59:11 +02:00
parent dd2268f7ac
commit 52adc006ba
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/insiders/getting-started.md
View File

@ -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