Skip to content

Commit dd2268f

Browse files
authored
Added alternate syntax to Insider plugins example (#3783)
* Add warning about merging sections between files * Use full example with alternative syntax * Revert accidentally commited changes * Revert another accidental commit
1 parent 8264e33 commit dd2268f

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

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

+22
Original file line numberDiff line numberDiff line change
@@ -185,4 +185,26 @@ 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:
192+
=== ":octicons-file-code-16: mkdocs.insiders.yml"
193+
194+
``` yaml
195+
INHERIT: mkdocs.yml
196+
plugins:
197+
social: {}
198+
```
199+
200+
=== ":octicons-file-code-16: mkdocs.yml"
201+
202+
``` yaml
203+
# Additional configuration above
204+
plugins:
205+
search: {}
206+
tags: {}
207+
```
208+
209+
188210
[configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance

0 commit comments

Comments
 (0)