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-01-28 16:26:15 +07:00
parent 294d38e8d3
commit 7dbb2b0546
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
2 changed files with 38 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/insiders/index.md
View File

@ -88,11 +88,12 @@ a handful of them, [thanks to our awesome sponsors]!
## What's in it for me? ## What's in it for me?
The moment you [become a sponsor][how to become a sponsor], you'll get __immediate The moment you [become a sponsor][how to become a sponsor], you'll get __immediate
access to 24 additional features__ that you can __start using now__, and access to 25 additional features__ that you can __start using now__, and
which are currently exclusively available to sponsors: which are currently exclusively available to sponsors:
<div class="mdx-columns" markdown> <div class="mdx-columns" markdown>
- [x] [Instant previews] :material-alert-decagram:{ .mdx-pulse title="Added on January 28, 2023" }
- [x] [Footnote tooltips] :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2023" } - [x] [Footnote tooltips] :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2023" }
- [x] [Tags plugin: advanced settings] :material-alert-decagram:{ .mdx-pulse title="Added on December 23, 2023" } - [x] [Tags plugin: advanced settings] :material-alert-decagram:{ .mdx-pulse title="Added on December 23, 2023" }
- [x] [Tags plugin: nested tags] :material-alert-decagram:{ .mdx-pulse title="Added on December 23, 2023" } - [x] [Tags plugin: nested tags] :material-alert-decagram:{ .mdx-pulse title="Added on December 23, 2023" }
@ -308,6 +309,7 @@ are released for general availability.
#### $ 24,000 – Blockpaprika #### $ 24,000 – Blockpaprika
- [x] [Instant previews]
- [x] [Projects plugin] - [x] [Projects plugin]
- [x] [Social plugin: custom layouts] - [x] [Social plugin: custom layouts]
- [x] [Social plugin: background images] - [x] [Social plugin: background images]
@ -318,6 +320,7 @@ are released for general availability.
- [x] [Tags plugin: shadow tags] - [x] [Tags plugin: shadow tags]
- [x] [Tags plugin: advanced settings] - [x] [Tags plugin: advanced settings]
[Instant previews]: ../setup/setting-up-navigation.md#instant-previews
[Projects plugin]: ../plugins/projects.md [Projects plugin]: ../plugins/projects.md
[Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#customization [Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#customization
[Social plugin: background images]: ../plugins/social.md#option.background_image [Social plugin: background images]: ../plugins/social.md#option.background_image

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

@ -74,6 +74,40 @@ The progress indicator will only show if the page hasn't finished loading after
400ms, so that fast connections will never show it for a better instant 400ms, so that fast connections will never show it for a better instant
experience. experience.
### Instant previews :material-alert-decagram:{ .mdx-pulse title="Added on January 28, 2024" }
<!-- md:sponsors -->
<!-- md:version insiders-4.52.0 -->
<!-- md:feature -->
<!-- md:flag experimental -->
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
keep the user in context. A link can be opted into instant previews with the
`data-preview` attribute:
```` markdown title="Link with instant preview"
``` markdown
[Attribute Lists](#){ data-preview }
```
````
<div class="result" markdown>
[Attribute Lists](extensions/python-markdown.md#attribute-lists){ data-preview }
</div>
Instant previews can also be enabled globally by adding the following lines to
`mkdocs.yml`, which will enable instant previews for all internal links,
alleviating the need to add data attributes:
``` yaml
theme:
features:
- navigation.instant.preview
```
### Anchor tracking ### Anchor tracking
<!-- md:version 8.0.0 --> <!-- md:version 8.0.0 -->