Skip to content

Commit

Permalink
Add warning about merging sections between files
Browse files Browse the repository at this point in the history
  • Loading branch information
cicdw committed Apr 1, 2022
1 parent 20c8f56 commit 51f56d9
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/insiders/getting-started.md
Expand Up @@ -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

0 comments on commit 51f56d9

Please sign in to comment.