From 050c299ec8b83cc1961a5ddabab453ac01d03e8a Mon Sep 17 00:00:00 2001 From: squidfunk Date: Fri, 31 Jan 2025 10:46:09 +0700 Subject: [PATCH] Documentation --- docs/insiders/benefits.md | 48 +++++++++++-------------- docs/plugins/meta.md | 16 ++------- docs/plugins/tags.md | 54 ++++++++++------------------- docs/reference/footnotes.md | 2 +- docs/reference/index.md | 3 +- docs/setup/setting-up-a-blog.md | 11 +++--- docs/setup/setting-up-navigation.md | 2 +- docs/setup/setting-up-tags.md | 3 +- 8 files changed, 50 insertions(+), 89 deletions(-) diff --git a/docs/insiders/benefits.md b/docs/insiders/benefits.md index f96016085..eabbb95e4 100644 --- a/docs/insiders/benefits.md +++ b/docs/insiders/benefits.md @@ -7,15 +7,15 @@ for you to __start using now__. ## Features -Our sponsors currently enjoy access to the following 26 additional features. New +Our sponsors currently enjoy access to the following 20 additional features. New features are added regularly, so be sure to check back regularly to stay updated.
-- [x] [Blog plugin: pinned posts] :material-alert-decagram:{ .mdx-pulse title="Added on February 24, 2024" } -- [x] [Instant previews] :material-alert-decagram:{ .mdx-pulse title="Added on January 28, 2024" } -- [x] [Footnote tooltips] :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2024" } +- [x] [Blog plugin: pinned posts] +- [x] [Instant previews] +- [x] [Footnote tooltips] - [x] [Tags plugin: advanced settings] - [x] [Tags plugin: nested tags] - [x] [Tags plugin: shadow tags] @@ -33,12 +33,6 @@ updated. - [x] [Navigation path] (Breadcrumbs) - [x] [Typeset plugin] - [x] [Privacy plugin: external links] -- [x] [Navigation subtitles] -- [x] [Tags plugin: allow list] + [custom sorting] -- [x] [Blog plugin: custom index pages] -- [x] [Blog plugin: related links] -- [x] [Meta plugin] -- [x] [Tags plugin: configurable listings]
@@ -100,23 +94,6 @@ planned, but not yet implemented. This means that each funding goal unlocks new features for general availability in the community edition, after sponsors have used them for a while. -#### $ 16,000 – Chipotle - -- [x] [Meta plugin] -- [x] [Blog plugin: related links] -- [x] [Blog plugin: custom index pages] -- [x] [Tags plugin: configurable listings] -- [x] [Tags plugin: allow list] + [custom sorting] -- [x] [Navigation subtitles] - - [Meta plugin]: ../plugins/meta.md - [Blog plugin: related links]: ../setup/setting-up-a-blog.md#adding-related-links - [Blog plugin: custom index pages]: ../setup/setting-up-a-blog.md#custom-index-pages - [Tags plugin: configurable listings]: ../setup/setting-up-tags.md#configurable-listings - [Tags plugin: allow list]: ../plugins/tags.md#config.tags_allowed - [custom sorting]: ../plugins/tags.md#config.tags_sort_by - [Navigation subtitles]: ../reference/index.md#setting-the-page-subtitle - #### $ 18,000 – Lemon Drop - [x] [Optimize plugin] @@ -184,6 +161,23 @@ sponsors. Those features were once part of Material for MkDocs Insiders, and therefore only available to our sponsors, and are now generally available to be used by all users. +#### $ 16,000 – Chipotle + +- [x] [Meta plugin] +- [x] [Blog plugin: related links] +- [x] [Blog plugin: custom index pages] +- [x] [Tags plugin: configurable listings] +- [x] [Tags plugin: allow list] + [custom sorting] +- [x] [Navigation subtitles] + + [Meta plugin]: ../plugins/meta.md + [Blog plugin: related links]: ../setup/setting-up-a-blog.md#adding-related-links + [Blog plugin: custom index pages]: ../setup/setting-up-a-blog.md#custom-index-pages + [Tags plugin: configurable listings]: ../setup/setting-up-tags.md#configurable-listings + [Tags plugin: allow list]: ../plugins/tags.md#config.tags_allowed + [custom sorting]: ../plugins/tags.md#config.tags_sort_by + [Navigation subtitles]: ../reference/index.md#setting-the-page-subtitle + #### $ 14,000 – Goat's Horn - [x] [Privacy plugin] diff --git a/docs/plugins/meta.md b/docs/plugins/meta.md index 5ab849602..4ef92ffde 100644 --- a/docs/plugins/meta.md +++ b/docs/plugins/meta.md @@ -10,13 +10,6 @@ pages in a folder, i.e., a subsection of your project, which is particularly useful to ensure that a certain subset of pages features specific tags, uses a custom template, or is attributed to an author. ---- - - __Sponsors only__ – this plugin is currently reserved to -[our awesome sponsors]. - - [our awesome sponsors]: ../insiders/index.md - ## Objective ### How it works @@ -132,8 +125,7 @@ of the meta plugin and other built-in plugins are: ## Configuration - - + @@ -160,8 +152,7 @@ The following settings are available: #### - - + 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: #### - - + Use this setting to change the meta file name the plugin will look for when diff --git a/docs/plugins/tags.md b/docs/plugins/tags.md index 87a26890c..0105d8ff2 100644 --- a/docs/plugins/tags.md +++ b/docs/plugins/tags.md @@ -167,8 +167,7 @@ The provided path is resolved from the [`docs` directory][mkdocs.docs_dir]. #### - - + Use this setting to change the function for generating URL-compatible slugs @@ -194,8 +193,7 @@ more granular control. #### - - + Use this setting to change the separator that is passed to the slugification @@ -212,8 +210,7 @@ plugins: #### - - + Use this setting to change the format string that is used when generating tag @@ -272,8 +269,7 @@ plugins: #### - - + 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 #### - - + Use this setting to reverse the order in which tags are sorted when comparing @@ -312,8 +307,7 @@ plugins: #### - - + Use this setting to change the name of the front matter property that is used by @@ -330,8 +324,7 @@ plugins: #### - - + Use this setting to change the name of the template variable that is used by @@ -348,8 +341,7 @@ plugins: #### - - + 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: #### - - + Use this setting to enable or disable listings. It is normally not necessary to @@ -400,8 +391,7 @@ is enabled. #### - - + 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. #### - - + 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 #### - - + Use this setting to reverse the order in which items are sorted when comparing @@ -481,8 +469,7 @@ plugins: #### - - + 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 #### - - + Use this setting to reverse the order in which tags are sorted when comparing @@ -521,8 +507,7 @@ plugins: #### - - + Use this setting to change the name of the directive the plugin will look for @@ -777,8 +762,7 @@ The following settings are available: #### - - + This setting specifies whether the listing should only consider pages that are @@ -879,8 +863,7 @@ setting on a per-listing basis: #### - - + 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. #### - - + Use this setting to specify which tags should be excluded from the listing. Each diff --git a/docs/reference/footnotes.md b/docs/reference/footnotes.md index 1a2ec5ca3..ad1c1b8bd 100644 --- a/docs/reference/footnotes.md +++ b/docs/reference/footnotes.md @@ -26,7 +26,7 @@ See additional configuration options: [Footnotes]: ../setup/extensions/python-markdown.md#footnotes -### Footnote tooltips :material-alert-decagram:{ .mdx-pulse title="Added on January 24, 2024" } +### Footnote tooltips diff --git a/docs/reference/index.md b/docs/reference/index.md index 741511c10..d13590c2f 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -144,8 +144,7 @@ page status] to get you started. ### Setting the page `subtitle` - - + Each page can define a subtitle, which is then rendered below the title as part diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md index 35dd9d665..bd1afab45 100644 --- a/docs/setup/setting-up-a-blog.md +++ b/docs/setup/setting-up-a-blog.md @@ -447,8 +447,7 @@ slug: hello-world #### Adding related links - - + 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 posts outside of the `posts` directory. The [built-in blog plugin] ensures that all links are correct. -#### Pinning a post :material-alert-decagram:{ .mdx-pulse title="Added on February 24, 2024" } +#### Pinning a post @@ -571,8 +570,7 @@ This will disable automatic reading time computation. #### Setting defaults - - + @@ -638,8 +636,7 @@ nav: ### Custom index pages - - + If you want to add custom content to automatically generated [archive] and diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index 3aa3b765e..b36aa9ec2 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -91,7 +91,7 @@ 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 diff --git a/docs/setup/setting-up-tags.md b/docs/setup/setting-up-tags.md index 644ea45e6..74cd69c26 100644 --- a/docs/setup/setting-up-tags.md +++ b/docs/setup/setting-up-tags.md @@ -224,8 +224,7 @@ for an arbitrary number of tags indexes (listings), [scoped listings], #### Configurable listings - - + Listings can be configured in `mkdocs.yml` or directly at the location of the