Skip to content

Commit 779c54e

Browse files
committed
Documentation
1 parent 7445b2a commit 779c54e

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

docs/setup/setting-up-navigation.md

+22-16
Original file line numberDiff line numberDiff line change
@@ -137,12 +137,13 @@ instant previews on a per-page or per-section level for your documentation:
137137
``` yaml
138138
markdown_extensions:
139139
- material.extensions.preview:
140-
targets:
141-
include:
142-
- changelog/index.md
143-
- customization.md
144-
- insiders/changelog/*
145-
- setup/extensions/*
140+
configurations:
141+
- targets:
142+
include:
143+
- changelog/index.md
144+
- customization.md
145+
- insiders/changelog/*
146+
- setup/extensions/*
146147
```
147148

148149
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.
154155
``` yaml
155156
markdown_extensions:
156157
- material.extensions.preview:
157-
sources: # (1)!
158-
include:
159-
- ...
160-
exclude:
161-
- ...
162-
targets: # (2)!
163-
include:
164-
- ...
165-
exclude:
166-
- ...
158+
configurations:
159+
- sources: # (1)!
160+
include:
161+
- ...
162+
exclude:
163+
- ...
164+
targets: # (2)!
165+
include:
166+
- ...
167+
exclude:
168+
- ...
167169
```
168170

169171
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.
172174
evaluated on top of inclusion, so if a page is matched by both, it will
173175
be excluded.
174176

177+
Note that you can define multiple items under the `configurations`
178+
setting, which allows to precisely control where instant previews are
179+
shown.
180+
175181
2. Targets specify the pages _to_ which instant previews should be enabled.
176182
This is the recommended way to enable instant previews.
177183
---

0 commit comments

Comments
 (0)