OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2024-03-09 14:22:56 +07:00
parent 9cd979ae6c
commit fdeafbb875
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -93,7 +93,7 @@ experience.
Instant previews are a brand new feature that allow the user to preview another Instant previews are a brand new feature that allow the user to preview another
site of your documentation without navigating to it. They can be very helpful to site of your documentation without navigating to it. They can be very helpful to
keep the user in context. Instant previews can be enabled on any internal link keep the user in context. Instant previews can be enabled on any header link
with the `data-preview` attribute: with the `data-preview` attribute:
```` markdown title="Link with instant preview" ```` markdown title="Link with instant preview"
@ -108,6 +108,14 @@ with the `data-preview` attribute:
</div> </div>
!!! info "Limitations"
Instant previews are still an experimental feature and currently limited to
headerlinks. This means, you can use them on any internal link that points
to a header on another page, but not other elements with `id` attributes.
After we have gathered enough feedback, we will consider extending this
feature to other, and possibly arbitrary elements.
#### Automatic previews #### Automatic previews
<!-- md:sponsors --> <!-- md:sponsors -->
@ -162,7 +170,7 @@ as well as for all Markdown extensions that we support.
--- ---
Instant previews can also be enabled globally by adding the following lines to Instant previews can also be enabled globally by adding the following lines to
`mkdocs.yml`, which will enable instant previews for all internal links, `mkdocs.yml`, which will enable instant previews for all header links,
alleviating the need to add data attributes: alleviating the need to add data attributes:
``` yaml ``` yaml