1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-28 01:10:58 +01:00

Documentation

This commit is contained in:
squidfunk 2024-01-24 15:45:24 +07:00
parent 9d52e36212
commit 672414163c
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
7 changed files with 37 additions and 9 deletions

View File

@ -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 23 additional features__ that you can __start using now__, and
access to 24 additional features__ that you can __start using now__, and
which are currently exclusively available to sponsors:
<div class="mdx-columns" markdown>
- [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" }
- [x] [Tags plugin: shadow tags] :material-alert-decagram:{ .mdx-pulse title="Added on December 23, 2023" }
@ -293,6 +294,7 @@ are released for general availability.
- [x] [Instant prefetching]
- [x] [Blog plugin: advanced settings]
- [x] [Blog plugin: author profiles]
- [x] [Footnote tooltips]
[Optimize plugin]: ../plugins/optimize.md
[Typeset plugin]: ../plugins/typeset.md
@ -302,6 +304,7 @@ are released for general availability.
[Instant prefetching]: ../setup/setting-up-navigation.md#instant-prefetching
[Blog plugin: advanced settings]: ../setup/setting-up-a-blog.md#advanced-settings
[Blog plugin: author profiles]: ../setup/setting-up-a-blog.md#adding-author-profiles
[Footnote tooltips]: ../reference/footnotes.md#footnote-tooltips
#### $ 24,000 Blockpaprika
@ -313,6 +316,7 @@ are released for general availability.
- [x] [Stay on page when switching languages]
- [x] [Tags plugin: nested tags]
- [x] [Tags plugin: shadow tags]
- [x] [Tags plugin: advanced settings]
[Projects plugin]: ../plugins/projects.md
[Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#customization
@ -322,13 +326,9 @@ are released for general availability.
[Stay on page when switching languages]: ../setup/changing-the-language.md#stay-on-page
[Tags plugin: nested tags]: ../setup/setting-up-tags.md#nested-tags
[Tags plugin: shadow tags]: ../setup/setting-up-tags.md#shadow-tags
#### $ 28,000 Lemon Drop
- [x] [Tags plugin: advanced settings]
[Tags plugin: advanced settings]: ../setup/setting-up-tags.md#advanced-settings
### Goals completed
This section lists all funding goals that were previously completed, which means

View File

@ -26,6 +26,28 @@ See additional configuration options:
[Footnotes]: ../setup/extensions/python-markdown.md#footnotes
### Footnote tooltips :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2024" }
<!-- md:sponsors -->
<!-- md:version insiders-4.51.0 -->
<!-- md:flag experimental -->
[Insiders] allows to render footnotes as inline tooltips, so the user can read
the footnote without leaving the context of the document. Footnote tooltips can
be enabled in `mkdocs.yml` with:
``` yaml
theme:
features:
- content.footnote.tooltips
```
__Footnote tooltips are enabled on our documentation__, so to try it out, you
can just hover or focus any footnote on this page or any other page of our
documentation.
[Insiders]: ../insiders/index.md
## Usage
### Adding footnote references

View File

@ -498,6 +498,11 @@
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-selection-button",
"const": "content.code.select"
},
{
"title": "Footnote tooltips",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/footnotes/#footnote-tooltips",
"const": "content.footnote.tooltips"
},
{
"title": "Linked content tabs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs",

View File

@ -9,7 +9,7 @@ further useful automatic optimization techniques.
## Configuration
### Built-in projects plugin :material-alert-decagram:{ .mdx-pulse title="Added on July 29, 2023" }
### Built-in projects plugin
<!-- md:sponsors -->
<!-- md:version insiders-4.38.0 -->

View File

@ -36,7 +36,7 @@ For a list of all settings, please consult the [plugin documentation].
[plugin documentation]: ../plugins/blog.md
#### Advanced settings :material-alert-decagram:{ .mdx-pulse title="Added on November 23, 2023" }
#### Advanced settings
<!-- md:sponsors -->
<!-- md:version insiders-4.44.0 -->

View File

@ -33,7 +33,7 @@ especially useful for large documentation sites.
[XHR]: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest
#### Instant prefetching :material-alert-decagram:{ .mdx-pulse title="Added on June 15, 2023" }
#### Instant prefetching
<!-- md:sponsors -->
<!-- md:version insiders-4.36.0 -->

View File

@ -44,6 +44,7 @@ theme:
- content.code.annotate
- content.code.copy
# - content.code.select
# - content.footnote.tooltips
# - content.tabs.link
- content.tooltips
# - header.autohide