Skip to content

Commit 050c299

Browse files
committed
Documentation
1 parent fefdd42 commit 050c299

File tree

8 files changed

+50
-89
lines changed

8 files changed

+50
-89
lines changed

docs/insiders/benefits.md

+21-27
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ for you to __start using now__.
77

88
## Features
99

10-
Our sponsors currently enjoy access to the following 26 additional features. New
10+
Our sponsors currently enjoy access to the following 20 additional features. New
1111
features are added regularly, so be sure to check back regularly to stay
1212
updated.
1313

1414
<div class="mdx-columns" markdown>
1515

16-
- [x] [Blog plugin: pinned posts] :material-alert-decagram:{ .mdx-pulse title="Added on February 24, 2024" }
17-
- [x] [Instant previews] :material-alert-decagram:{ .mdx-pulse title="Added on January 28, 2024" }
18-
- [x] [Footnote tooltips] :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2024" }
16+
- [x] [Blog plugin: pinned posts]
17+
- [x] [Instant previews]
18+
- [x] [Footnote tooltips]
1919
- [x] [Tags plugin: advanced settings]
2020
- [x] [Tags plugin: nested tags]
2121
- [x] [Tags plugin: shadow tags]
@@ -33,12 +33,6 @@ updated.
3333
- [x] [Navigation path] (Breadcrumbs)
3434
- [x] [Typeset plugin]
3535
- [x] [Privacy plugin: external links]
36-
- [x] [Navigation subtitles]
37-
- [x] [Tags plugin: allow list] + [custom sorting]
38-
- [x] [Blog plugin: custom index pages]
39-
- [x] [Blog plugin: related links]
40-
- [x] [Meta plugin]
41-
- [x] [Tags plugin: configurable listings]
4236

4337
</div>
4438

@@ -100,23 +94,6 @@ planned, but not yet implemented. This means that each funding goal unlocks new
10094
features for general availability in the community edition, after sponsors have
10195
used them for a while.
10296

103-
#### $ 16,000 – Chipotle
104-
105-
- [x] [Meta plugin]
106-
- [x] [Blog plugin: related links]
107-
- [x] [Blog plugin: custom index pages]
108-
- [x] [Tags plugin: configurable listings]
109-
- [x] [Tags plugin: allow list] + [custom sorting]
110-
- [x] [Navigation subtitles]
111-
112-
[Meta plugin]: ../plugins/meta.md
113-
[Blog plugin: related links]: ../setup/setting-up-a-blog.md#adding-related-links
114-
[Blog plugin: custom index pages]: ../setup/setting-up-a-blog.md#custom-index-pages
115-
[Tags plugin: configurable listings]: ../setup/setting-up-tags.md#configurable-listings
116-
[Tags plugin: allow list]: ../plugins/tags.md#config.tags_allowed
117-
[custom sorting]: ../plugins/tags.md#config.tags_sort_by
118-
[Navigation subtitles]: ../reference/index.md#setting-the-page-subtitle
119-
12097
#### $ 18,000 – Lemon Drop
12198

12299
- [x] [Optimize plugin]
@@ -184,6 +161,23 @@ sponsors. Those features were once part of Material for MkDocs Insiders, and
184161
therefore only available to our sponsors, and are now generally available to
185162
be used by all users.
186163

164+
#### $ 16,000 – Chipotle
165+
166+
- [x] [Meta plugin]
167+
- [x] [Blog plugin: related links]
168+
- [x] [Blog plugin: custom index pages]
169+
- [x] [Tags plugin: configurable listings]
170+
- [x] [Tags plugin: allow list] + [custom sorting]
171+
- [x] [Navigation subtitles]
172+
173+
[Meta plugin]: ../plugins/meta.md
174+
[Blog plugin: related links]: ../setup/setting-up-a-blog.md#adding-related-links
175+
[Blog plugin: custom index pages]: ../setup/setting-up-a-blog.md#custom-index-pages
176+
[Tags plugin: configurable listings]: ../setup/setting-up-tags.md#configurable-listings
177+
[Tags plugin: allow list]: ../plugins/tags.md#config.tags_allowed
178+
[custom sorting]: ../plugins/tags.md#config.tags_sort_by
179+
[Navigation subtitles]: ../reference/index.md#setting-the-page-subtitle
180+
187181
#### $ 14,000 – Goat's Horn
188182

189183
- [x] [Privacy plugin]

docs/plugins/meta.md

+3-13
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,6 @@ pages in a folder, i.e., a subsection of your project, which is particularly
1010
useful to ensure that a certain subset of pages features specific tags, uses a
1111
custom template, or is attributed to an author.
1212

13-
---
14-
15-
<!-- md:sponsors --> __Sponsors only__ – this plugin is currently reserved to
16-
[our awesome sponsors].
17-
18-
[our awesome sponsors]: ../insiders/index.md
19-
2013
## Objective
2114

2215
### How it works
@@ -132,8 +125,7 @@ of the meta plugin and other built-in plugins are:
132125

133126
## Configuration
134127

135-
<!-- md:sponsors -->
136-
<!-- md:version insiders-4.21.0 -->
128+
<!-- md:version 9.6.0 -->
137129
<!-- md:plugin [meta] – built-in -->
138130
<!-- md:flag experimental -->
139131

@@ -160,8 +152,7 @@ The following settings are available:
160152

161153
#### <!-- md:setting config.enabled -->
162154

163-
<!-- md:sponsors -->
164-
<!-- md:version insiders-4.38.0 -->
155+
<!-- md:version 9.6.0 -->
165156
<!-- md:default `true` -->
166157

167158
Use this setting to enable or disable the plugin when [building your project].
@@ -184,8 +175,7 @@ The following settings are available for meta files:
184175

185176
#### <!-- md:setting config.meta_file -->
186177

187-
<!-- md:sponsors -->
188-
<!-- md:version insiders-4.21.0 -->
178+
<!-- md:version 9.6.0 -->
189179
<!-- md:default `.meta.yml` -->
190180

191181
Use this setting to change the meta file name the plugin will look for when

docs/plugins/tags.md

+18-36
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,7 @@ The provided path is resolved from the [`docs` directory][mkdocs.docs_dir].
167167

168168
#### <!-- md:setting config.tags_slugify -->
169169

170-
<!-- md:sponsors -->
171-
<!-- md:version insiders-4.25.0 -->
170+
<!-- md:version 9.6.0 -->
172171
<!-- md:default [`pymdownx.slugs.slugify`][pymdownx.slugs.slugify] -->
173172

174173
Use this setting to change the function for generating URL-compatible slugs
@@ -194,8 +193,7 @@ more granular control.
194193

195194
#### <!-- md:setting config.tags_slugify_separator -->
196195

197-
<!-- md:sponsors -->
198-
<!-- md:version insiders-4.25.0 -->
196+
<!-- md:version 9.6.0 -->
199197
<!-- md:default `-` -->
200198

201199
Use this setting to change the separator that is passed to the slugification
@@ -212,8 +210,7 @@ plugins:
212210

213211
#### <!-- md:setting config.tags_slugify_format -->
214212

215-
<!-- md:sponsors -->
216-
<!-- md:version insiders-4.48.0 -->
213+
<!-- md:version 9.6.0 -->
217214
<!-- md:default `tag:{slug}` -->
218215

219216
Use this setting to change the format string that is used when generating tag
@@ -272,8 +269,7 @@ plugins:
272269

273270
#### <!-- md:setting config.tags_sort_by -->
274271

275-
<!-- md:sponsors -->
276-
<!-- md:version insiders-4.26.2 -->
272+
<!-- md:version 9.6.0 -->
277273
<!-- md:default `material.plugins.tags.tag_name` -->
278274

279275
Use this setting to specify a custom function for comparing tags. By default,
@@ -294,8 +290,7 @@ or number representing the tag, that is used for sorting, and reference it in
294290

295291
#### <!-- md:setting config.tags_sort_reverse -->
296292

297-
<!-- md:sponsors -->
298-
<!-- md:version insiders-4.26.2 -->
293+
<!-- md:version 9.6.0 -->
299294
<!-- md:default `false` -->
300295

301296
Use this setting to reverse the order in which tags are sorted when comparing
@@ -312,8 +307,7 @@ plugins:
312307

313308
#### <!-- md:setting config.tags_name_property -->
314309

315-
<!-- md:sponsors -->
316-
<!-- md:version insiders-4.48.0 -->
310+
<!-- md:version 9.6.0 -->
317311
<!-- md:default [`tags`][meta.tags] -->
318312

319313
Use this setting to change the name of the front matter property that is used by
@@ -330,8 +324,7 @@ plugins:
330324

331325
#### <!-- md:setting config.tags_name_variable -->
332326

333-
<!-- md:sponsors -->
334-
<!-- md:version insiders-4.48.0 -->
327+
<!-- md:version 9.6.0 -->
335328
<!-- md:default `tags` -->
336329

337330
Use this setting to change the name of the template variable that is used by
@@ -348,8 +341,7 @@ plugins:
348341

349342
#### <!-- md:setting config.tags_allowed -->
350343

351-
<!-- md:sponsors -->
352-
<!-- md:version insiders-4.25.0 -->
344+
<!-- md:version 9.6.0 -->
353345
<!-- md:default none -->
354346

355347
The plugin allows to check tags against a predefined list, in order to catch
@@ -377,8 +369,7 @@ The following settings are available for listings:
377369

378370
#### <!-- md:setting config.listings -->
379371

380-
<!-- md:sponsors -->
381-
<!-- md:version insiders-4.48.0 -->
372+
<!-- md:version 9.6.0 -->
382373
<!-- md:default `true` -->
383374

384375
Use this setting to enable or disable listings. It is normally not necessary to
@@ -400,8 +391,7 @@ is enabled.
400391

401392
#### <!-- md:setting config.listings_map -->
402393

403-
<!-- md:sponsors -->
404-
<!-- md:version insiders-4.48.0 -->
394+
<!-- md:version 9.6.0 -->
405395
<!-- md:default none -->
406396

407397
Use this define listing configurations that you can then reference in listings
@@ -431,8 +421,7 @@ See the [listings section] for a list of all available settings.
431421

432422
#### <!-- md:setting config.listings_sort_by -->
433423

434-
<!-- md:sponsors -->
435-
<!-- md:version insiders-4.39.0 -->
424+
<!-- md:version 9.6.0 -->
436425
<!-- md:default `material.plugins.tags.item_title` -->
437426

438427
Use this setting to specify a custom function for comparing listing items. By
@@ -463,8 +452,7 @@ or number representing the item, that is used for sorting, and reference it in
463452

464453
#### <!-- md:setting config.listings_sort_reverse -->
465454

466-
<!-- md:sponsors -->
467-
<!-- md:version insiders-4.39.0 -->
455+
<!-- md:version 9.6.0 -->
468456
<!-- md:default `false` -->
469457

470458
Use this setting to reverse the order in which items are sorted when comparing
@@ -481,8 +469,7 @@ plugins:
481469

482470
#### <!-- md:setting config.listings_tags_sort_by -->
483471

484-
<!-- md:sponsors -->
485-
<!-- md:version insiders-4.48.0 -->
472+
<!-- md:version 9.6.0 -->
486473
<!-- md:default `material.plugins.tags.tag_name` -->
487474

488475
Use this setting to specify a custom function for comparing tags in listings. By
@@ -503,8 +490,7 @@ or number representing the tag, that is used for sorting, and reference it in
503490

504491
#### <!-- md:setting config.listings_tags_sort_reverse -->
505492

506-
<!-- md:sponsors -->
507-
<!-- md:version insiders-4.48.0 -->
493+
<!-- md:version 9.6.0 -->
508494
<!-- md:default `false` -->
509495

510496
Use this setting to reverse the order in which tags are sorted when comparing
@@ -521,8 +507,7 @@ plugins:
521507

522508
#### <!-- md:setting config.listings_directive -->
523509

524-
<!-- md:sponsors -->
525-
<!-- md:version insiders-4.48.0 -->
510+
<!-- md:version 9.6.0 -->
526511
<!-- md:default `material/tags` -->
527512

528513
Use this setting to change the name of the directive the plugin will look for
@@ -777,8 +762,7 @@ The following settings are available:
777762

778763
#### <!-- md:setting listing.scope -->
779764

780-
<!-- md:sponsors -->
781-
<!-- md:version insiders-4.48.0 -->
765+
<!-- md:version 9.6.0 -->
782766
<!-- md:default `false` -->
783767

784768
This setting specifies whether the listing should only consider pages that are
@@ -879,8 +863,7 @@ setting on a per-listing basis:
879863

880864
#### <!-- md:setting listing.include -->
881865

882-
<!-- md:sponsors -->
883-
<!-- md:version insiders-4.48.0 -->
866+
<!-- md:version 9.6.0 -->
884867
<!-- md:default none -->
885868

886869
Use this setting to specify which tags should be included in the listing. Each
@@ -917,8 +900,7 @@ If this setting is left empty, all tags and pages are included.
917900

918901
#### <!-- md:setting listing.exclude -->
919902

920-
<!-- md:sponsors -->
921-
<!-- md:version insiders-4.48.0 -->
903+
<!-- md:version 9.6.0 -->
922904
<!-- md:default none -->
923905

924906
Use this setting to specify which tags should be excluded from the listing. Each

docs/reference/footnotes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ 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" }
29+
### Footnote tooltips
3030
3131
<!-- md:sponsors -->
3232
<!-- md:version insiders-4.51.0 -->

docs/reference/index.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,7 @@ page status] to get you started.
144144

145145
### Setting the page `subtitle`
146146

147-
<!-- md:sponsors -->
148-
<!-- md:version insiders-4.25.0 -->
147+
<!-- md:version 9.6.0 -->
149148
<!-- md:flag experimental -->
150149

151150
Each page can define a subtitle, which is then rendered below the title as part

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

+4-7
Original file line numberDiff line numberDiff line change
@@ -447,8 +447,7 @@ slug: hello-world
447447

448448
#### Adding related links
449449

450-
<!-- md:sponsors -->
451-
<!-- md:version insiders-4.23.0 -->
450+
<!-- md:version 9.6.0 -->
452451
<!-- md:flag experimental -->
453452

454453
Related links offer the perfect way to prominently add a _further reading_
@@ -519,7 +518,7 @@ when the site is being built. Of course, you can also reference assets from
519518
posts outside of the `posts` directory. The [built-in blog plugin] ensures that
520519
all links are correct.
521520

522-
#### Pinning a post :material-alert-decagram:{ .mdx-pulse title="Added on February 24, 2024" }
521+
#### Pinning a post
523522

524523
<!-- md:sponsors -->
525524
<!-- md:version insiders-4.53.0 -->
@@ -571,8 +570,7 @@ This will disable automatic reading time computation.
571570

572571
#### Setting defaults
573572

574-
<!-- md:sponsors -->
575-
<!-- md:version insiders-4.21.0 -->
573+
<!-- md:version 9.6.0 -->
576574
<!-- md:plugin [meta][built-in meta plugin] – built-in -->
577575
<!-- md:flag experimental -->
578576

@@ -638,8 +636,7 @@ nav:
638636

639637
### Custom index pages
640638

641-
<!-- md:sponsors -->
642-
<!-- md:version insiders-4.24.0 -->
639+
<!-- md:version 9.6.0 -->
643640
<!-- md:flag experimental -->
644641

645642
If you want to add custom content to automatically generated [archive] and

docs/setup/setting-up-navigation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ The progress indicator will only show if the page hasn't finished loading after
9191
400ms, so that fast connections will never show it for a better instant
9292
experience.
9393

94-
### Instant previews :material-alert-decagram:{ .mdx-pulse title="Added on January 28, 2024" }
94+
### Instant previews
9595

9696
<!-- md:sponsors -->
9797
<!-- md:version insiders-4.52.0 -->

docs/setup/setting-up-tags.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -224,8 +224,7 @@ for an arbitrary number of tags indexes (listings), [scoped listings],
224224

225225
#### Configurable listings
226226

227-
<!-- md:sponsors -->
228-
<!-- md:version insiders-4.48.0 -->
227+
<!-- md:version 9.6.0 -->
229228
<!-- md:flag experimental -->
230229

231230
Listings can be configured in `mkdocs.yml` or directly at the location of the

0 commit comments

Comments
 (0)