Skip to content

Commit 6724141

Browse files
committed
Documentation
1 parent 9d52e36 commit 6724141

File tree

7 files changed

+37
-9
lines changed

7 files changed

+37
-9
lines changed

docs/insiders/index.md

Lines changed: 6 additions & 6 deletions
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 23 additional features__ that you can __start using now__, and
91+
access to 24 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] [Footnote tooltips] :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2023" }
9697
- [x] [Tags plugin: advanced settings] :material-alert-decagram:{ .mdx-pulse title="Added on December 23, 2023" }
9798
- [x] [Tags plugin: nested tags] :material-alert-decagram:{ .mdx-pulse title="Added on December 23, 2023" }
9899
- [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.
293294
- [x] [Instant prefetching]
294295
- [x] [Blog plugin: advanced settings]
295296
- [x] [Blog plugin: author profiles]
297+
- [x] [Footnote tooltips]
296298

297299
[Optimize plugin]: ../plugins/optimize.md
298300
[Typeset plugin]: ../plugins/typeset.md
@@ -302,6 +304,7 @@ are released for general availability.
302304
[Instant prefetching]: ../setup/setting-up-navigation.md#instant-prefetching
303305
[Blog plugin: advanced settings]: ../setup/setting-up-a-blog.md#advanced-settings
304306
[Blog plugin: author profiles]: ../setup/setting-up-a-blog.md#adding-author-profiles
307+
[Footnote tooltips]: ../reference/footnotes.md#footnote-tooltips
305308

306309
#### $ 24,000 – Blockpaprika
307310

@@ -313,6 +316,7 @@ are released for general availability.
313316
- [x] [Stay on page when switching languages]
314317
- [x] [Tags plugin: nested tags]
315318
- [x] [Tags plugin: shadow tags]
319+
- [x] [Tags plugin: advanced settings]
316320

317321
[Projects plugin]: ../plugins/projects.md
318322
[Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#customization
@@ -322,13 +326,9 @@ are released for general availability.
322326
[Stay on page when switching languages]: ../setup/changing-the-language.md#stay-on-page
323327
[Tags plugin: nested tags]: ../setup/setting-up-tags.md#nested-tags
324328
[Tags plugin: shadow tags]: ../setup/setting-up-tags.md#shadow-tags
325-
326-
#### $ 28,000 – Lemon Drop
327-
328-
- [x] [Tags plugin: advanced settings]
329-
330329
[Tags plugin: advanced settings]: ../setup/setting-up-tags.md#advanced-settings
331330

331+
332332
### Goals completed
333333

334334
This section lists all funding goals that were previously completed, which means

docs/reference/footnotes.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,28 @@ See additional configuration options:
2626
2727
[Footnotes]: ../setup/extensions/python-markdown.md#footnotes
2828
29+
### Footnote tooltips :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2024" }
30+
31+
<!-- md:sponsors -->
32+
<!-- md:version insiders-4.51.0 -->
33+
<!-- md:flag experimental -->
34+
35+
[Insiders] allows to render footnotes as inline tooltips, so the user can read
36+
the footnote without leaving the context of the document. Footnote tooltips can
37+
be enabled in `mkdocs.yml` with:
38+
39+
``` yaml
40+
theme:
41+
features:
42+
- content.footnote.tooltips
43+
```
44+
45+
__Footnote tooltips are enabled on our documentation__, so to try it out, you
46+
can just hover or focus any footnote on this page or any other page of our
47+
documentation.
48+
49+
[Insiders]: ../insiders/index.md
50+
2951
## Usage
3052

3153
### Adding footnote references

docs/schema/theme.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,11 @@
498498
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-selection-button",
499499
"const": "content.code.select"
500500
},
501+
{
502+
"title": "Footnote tooltips",
503+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/footnotes/#footnote-tooltips",
504+
"const": "content.footnote.tooltips"
505+
},
501506
{
502507
"title": "Linked content tabs",
503508
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs",

docs/setup/building-an-optimized-site.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ further useful automatic optimization techniques.
99

1010
## Configuration
1111

12-
### Built-in projects plugin :material-alert-decagram:{ .mdx-pulse title="Added on July 29, 2023" }
12+
### Built-in projects plugin
1313

1414
<!-- md:sponsors -->
1515
<!-- md:version insiders-4.38.0 -->

docs/setup/setting-up-a-blog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ For a list of all settings, please consult the [plugin documentation].
3636
3737
[plugin documentation]: ../plugins/blog.md
3838
39-
#### Advanced settings :material-alert-decagram:{ .mdx-pulse title="Added on November 23, 2023" }
39+
#### Advanced settings
4040
4141
<!-- md:sponsors -->
4242
<!-- md:version insiders-4.44.0 -->

docs/setup/setting-up-navigation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ especially useful for large documentation sites.
3333
3434
[XHR]: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest
3535
36-
#### Instant prefetching :material-alert-decagram:{ .mdx-pulse title="Added on June 15, 2023" }
36+
#### Instant prefetching
3737
3838
<!-- md:sponsors -->
3939
<!-- md:version insiders-4.36.0 -->

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ theme:
4444
- content.code.annotate
4545
- content.code.copy
4646
# - content.code.select
47+
# - content.footnote.tooltips
4748
# - content.tabs.link
4849
- content.tooltips
4950
# - header.autohide

0 commit comments

Comments
 (0)