Skip to content

Commit

Permalink
Added alternate syntax to Insider plugins example (#3783)
Browse files Browse the repository at this point in the history
* Add warning about merging sections between files

* Use full example with alternative syntax

* Revert accidentally commited changes

* Revert another accidental commit
  • Loading branch information
cicdw committed Apr 6, 2022
1 parent 8264e33 commit dd2268f
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/insiders/getting-started.md
Expand Up @@ -185,4 +185,26 @@ 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:
=== ":octicons-file-code-16: mkdocs.insiders.yml"

``` yaml
INHERIT: mkdocs.yml
plugins:
social: {}
```

=== ":octicons-file-code-16: mkdocs.yml"

``` yaml
# Additional configuration above
plugins:
search: {}
tags: {}
```


[configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance

0 comments on commit dd2268f

Please sign in to comment.