@@ -93,7 +93,7 @@ experience.
93
93
94
94
Instant previews are a brand new feature that allow the user to preview another
95
95
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
97
97
with the `data-preview` attribute :
98
98
99
99
` ` ` ` markdown title="Link with instant preview"
@@ -108,6 +108,14 @@ with the `data-preview` attribute:
108
108
109
109
</div>
110
110
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
+
111
119
# ### Automatic previews
112
120
113
121
<!-- md:sponsors -->
@@ -162,7 +170,7 @@ as well as for all Markdown extensions that we support.
162
170
---
163
171
164
172
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,
166
174
alleviating the need to add data attributes :
167
175
168
176
` ` ` yaml
0 commit comments