Skip to content

Commit 7dbb2b0

Browse files
committed
Documentation
1 parent 294d38e commit 7dbb2b0

File tree

2 files changed

+38
-1
lines changed

2 files changed

+38
-1
lines changed

docs/insiders/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,12 @@ a handful of them, [thanks to our awesome sponsors]!
8888
## What's in it for me?
8989

9090
The moment you [become a sponsor][how to become a sponsor], you'll get __immediate
91-
access to 24 additional features__ that you can __start using now__, and
91+
access to 25 additional features__ that you can __start using now__, and
9292
which are currently exclusively available to sponsors:
9393

9494
<div class="mdx-columns" markdown>
9595

96+
- [x] [Instant previews] :material-alert-decagram:{ .mdx-pulse title="Added on January 28, 2023" }
9697
- [x] [Footnote tooltips] :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2023" }
9798
- [x] [Tags plugin: advanced settings] :material-alert-decagram:{ .mdx-pulse title="Added on December 23, 2023" }
9899
- [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.
308309

309310
#### $ 24,000 – Blockpaprika
310311

312+
- [x] [Instant previews]
311313
- [x] [Projects plugin]
312314
- [x] [Social plugin: custom layouts]
313315
- [x] [Social plugin: background images]
@@ -318,6 +320,7 @@ are released for general availability.
318320
- [x] [Tags plugin: shadow tags]
319321
- [x] [Tags plugin: advanced settings]
320322

323+
[Instant previews]: ../setup/setting-up-navigation.md#instant-previews
321324
[Projects plugin]: ../plugins/projects.md
322325
[Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#customization
323326
[Social plugin: background images]: ../plugins/social.md#option.background_image

docs/setup/setting-up-navigation.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,40 @@ The progress indicator will only show if the page hasn't finished loading after
7474
400ms, so that fast connections will never show it for a better instant
7575
experience.
7676

77+
### Instant previews :material-alert-decagram:{ .mdx-pulse title="Added on January 28, 2024" }
78+
79+
<!-- md:sponsors -->
80+
<!-- md:version insiders-4.52.0 -->
81+
<!-- md:feature -->
82+
<!-- md:flag experimental -->
83+
84+
Instant previews are a brand new feature that allow the user to preview another
85+
site of your documentation without navigating to it. They can be very helpful to
86+
keep the user in context. A link can be opted into instant previews with the
87+
`data-preview` attribute:
88+
89+
```` markdown title="Link with instant preview"
90+
``` markdown
91+
[Attribute Lists](#){ data-preview }
92+
```
93+
````
94+
95+
<div class="result" markdown>
96+
97+
[Attribute Lists](extensions/python-markdown.md#attribute-lists){ data-preview }
98+
99+
</div>
100+
101+
Instant previews can also be enabled globally by adding the following lines to
102+
`mkdocs.yml`, which will enable instant previews for all internal links,
103+
alleviating the need to add data attributes:
104+
105+
``` yaml
106+
theme:
107+
features:
108+
- navigation.instant.preview
109+
```
110+
77111
### Anchor tracking
78112

79113
<!-- md:version 8.0.0 -->

0 commit comments

Comments
 (0)