starred/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2026-07-30 17:46:21 -04:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk
2025-02-20 08:34:42 +07:00
parent 7445b2aa60
commit 779c54ef47
1 changed files with 22 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/setup/setting-up-navigation.md
View File

@@ -137,12 +137,13 @@ instant previews on a per-page or per-section level for your documentation:
``` yaml
markdown_extensions:
- material.extensions.preview:
targets:
include:
- changelog/index.md
- customization.md
- insiders/changelog/*
- setup/extensions/*
configurations:
- targets:
include:
- changelog/index.md
- customization.md
- insiders/changelog/*
- setup/extensions/*
```
The above configuration is what we use for our documentation. We've enabled
@@ -154,16 +155,17 @@ as well as for all Markdown extensions that we support.
``` yaml
markdown_extensions:
- material.extensions.preview:
sources: # (1)!
include:
- ...
exclude:
- ...
targets: # (2)!
include:
- ...
exclude:
- ...
configurations:
- sources: # (1)!
include:
- ...
exclude:
- ...
targets: # (2)!
include:
- ...
exclude:
- ...
```
1. Sources specify the pages _on_ which instant previews should be enabled.
@@ -172,6 +174,10 @@ as well as for all Markdown extensions that we support.
evaluated on top of inclusion, so if a page is matched by both, it will
be excluded.
Note that you can define multiple items under the `configurations`
setting, which allows to precisely control where instant previews are
shown.
2. Targets specify the pages _to_ which instant previews should be enabled.
This is the recommended way to enable instant previews.
---