Skip to content

Commit fdeafbb

Browse files
committed
Documentation
1 parent 9cd979a commit fdeafbb

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/setup/setting-up-navigation.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ experience.
9393

9494
Instant previews are a brand new feature that allow the user to preview another
9595
site of your documentation without navigating to it. They can be very helpful to
96-
keep the user in context. Instant previews can be enabled on any internal link
96+
keep the user in context. Instant previews can be enabled on any header link
9797
with the `data-preview` attribute:
9898

9999
```` markdown title="Link with instant preview"
@@ -108,6 +108,14 @@ with the `data-preview` attribute:
108108

109109
</div>
110110

111+
!!! info "Limitations"
112+
113+
Instant previews are still an experimental feature and currently limited to
114+
headerlinks. This means, you can use them on any internal link that points
115+
to a header on another page, but not other elements with `id` attributes.
116+
After we have gathered enough feedback, we will consider extending this
117+
feature to other, and possibly arbitrary elements.
118+
111119
#### Automatic previews
112120

113121
<!-- md:sponsors -->
@@ -162,7 +170,7 @@ as well as for all Markdown extensions that we support.
162170
---
163171

164172
Instant previews can also be enabled globally by adding the following lines to
165-
`mkdocs.yml`, which will enable instant previews for all internal links,
173+
`mkdocs.yml`, which will enable instant previews for all header links,
166174
alleviating the need to add data attributes:
167175

168176
``` yaml

0 commit comments

Comments
 (0)