From 7dbb2b054661856d8ac437b8489a80c34252aee1 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 28 Jan 2024 16:26:15 +0700 Subject: [PATCH] Documentation --- docs/insiders/index.md | 5 ++++- docs/setup/setting-up-navigation.md | 34 +++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 1 deletion(-) diff --git a/docs/insiders/index.md b/docs/insiders/index.md index 49f5e25cb..3fbb697c5 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -88,11 +88,12 @@ a handful of them, [thanks to our awesome sponsors]! ## What's in it for me? 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:
+- [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] [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" } @@ -308,6 +309,7 @@ are released for general availability. #### $ 24,000 – Blockpaprika +- [x] [Instant previews] - [x] [Projects plugin] - [x] [Social plugin: custom layouts] - [x] [Social plugin: background images] @@ -318,6 +320,7 @@ are released for general availability. - [x] [Tags plugin: shadow tags] - [x] [Tags plugin: advanced settings] + [Instant previews]: ../setup/setting-up-navigation.md#instant-previews [Projects plugin]: ../plugins/projects.md [Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#customization [Social plugin: background images]: ../plugins/social.md#option.background_image diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index a9867766f..f9ab4dc78 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -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 experience. +### Instant previews :material-alert-decagram:{ .mdx-pulse title="Added on January 28, 2024" } + + + + + + +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 } +``` +```` + +
+ +[Attribute Lists](extensions/python-markdown.md#attribute-lists){ data-preview } + +
+ +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