Merge pull request #7942 from squidfunk/merge/chipotle

Merged features tied to 'Chipotle' funding goal

Author: squidfunk

CHANGELOG

@@ -1,3 +1,14 @@
+mkdocs-material-9.6.0 (2025-01-31)
+
+  * Added meta plugin
+  * Rewrite of the tags plugin
+  * Added support for allow lists in tags plugin
+  * Added support for and custom sorting in tags plugin
+  * Added support for related links in blog plugin
+  * Added support for custom index pages in blog plugin
+  * Added support for navigation subtitles
+  * Fixed #7924: Anchors might require two clicks when using instant navigation
+
 mkdocs-material-9.5.50 (2025-01-18)
 
   * Fixed #7913: Social plugin renders attribute lists in page title

docs/changelog/index.md

@@ -2,6 +2,17 @@
 
 ## Material for MkDocs
 
+### 9.6.0 <small>January 31, 2025</small> { id="9.6.0" }
+
+- Added meta plugin
+- Rewrite of the tags plugin
+- Added support for allow lists in tags plugin
+- Added support for and custom sorting in tags plugin
+- Added support for related links in blog plugin
+- Added support for custom index pages in blog plugin
+- Added support for navigation subtitles
+- Fixed #7924: Anchors might require two clicks when using instant navigation
+
 ### 9.5.50 <small>January 18, 2025</small> { id="9.5.50" }
 
 - Fixed #7913: Social plugin renders attribute lists in page title

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.
 
 <div class="mdx-columns" markdown>
 
-- [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]
 
 </div>
 
@@ -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]

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.
 
----
-
-<!-- md:sponsors --> __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
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.21.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:plugin [meta] – built-in -->
 <!-- md:flag experimental -->
 
@@ -160,8 +152,7 @@ The following settings are available:
 
 #### <!-- md:setting config.enabled -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.38.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `true` -->
 
 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:
 
 #### <!-- md:setting config.meta_file -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.21.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `.meta.yml` -->
 
 Use this setting to change the meta file name the plugin will look for when

docs/plugins/tags.md

@@ -134,12 +134,14 @@ is enabled.
 <!-- md:version 8.2.0 -->
 <!-- md:default none -->
 
-!!! info "This setting is not needed in [Insiders]"
+!!! warning "This setting is deprecated"
 
-    Insiders ships a __ground up rewrite of the tags plugin__ which is infinitely
-    more powerful than the current version in the community edition. It allows
-    for an arbitrary number of tags indexes (listings), [scoped listings],
-    [shadow tags], [nested tags], and much more.
+    As of version <!-- md:version 9.6.0 -->, this setting is deprecated, as this
+    version ships a __ground up rewrite of the tags plugin__ which is much more
+    powerful than the previous version. Tags [listings] can be used on any page
+    now.
+
+<div style="opacity: 0.5" markdown>
 
 Use this setting to specify the location of the tags index, which is the page
 used to render a list of all tags and their associated pages. If this setting is
@@ -158,17 +160,15 @@ if you want to have a tags index.
 
 The provided path is resolved from the [`docs` directory][mkdocs.docs_dir].
 
-  [Insiders]: ../insiders/index.md
-  [scoped listings]: ../setup/setting-up-tags.md#scoped-listings
-  [shadow tags]: ../setup/setting-up-tags.md#shadow-tags
-  [nested tags]: ../setup/setting-up-tags.md#nested-tags
+</div>
+
+  [listings]: ../setup/setting-up-tags.md#adding-a-tags-index
 
 ---
 
 #### <!-- md:setting config.tags_slugify -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.25.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default [`pymdownx.slugs.slugify`][pymdownx.slugs.slugify] -->
 
 Use this setting to change the function for generating URL-compatible slugs
@@ -194,8 +194,7 @@ more granular control.
 
 #### <!-- md:setting config.tags_slugify_separator -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.25.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `-` -->
 
 Use this setting to change the separator that is passed to the slugification
@@ -212,8 +211,7 @@ plugins:
 
 #### <!-- md:setting config.tags_slugify_format -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.48.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `tag:{slug}` -->
 
 Use this setting to change the format string that is used when generating tag
@@ -272,8 +270,7 @@ plugins:
 
 #### <!-- md:setting config.tags_sort_by -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.26.2 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `material.plugins.tags.tag_name` -->
 
 Use this setting to specify a custom function for comparing tags. By default,
@@ -294,8 +291,7 @@ or number representing the tag, that is used for sorting, and reference it in
 
 #### <!-- md:setting config.tags_sort_reverse -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.26.2 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `false` -->
 
 Use this setting to reverse the order in which tags are sorted when comparing
@@ -312,8 +308,7 @@ plugins:
 
 #### <!-- md:setting config.tags_name_property -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.48.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default [`tags`][meta.tags] -->
 
 Use this setting to change the name of the front matter property that is used by
@@ -330,8 +325,7 @@ plugins:
 
 #### <!-- md:setting config.tags_name_variable -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.48.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `tags` -->
 
 Use this setting to change the name of the template variable that is used by
@@ -348,8 +342,7 @@ plugins:
 
 #### <!-- md:setting config.tags_allowed -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.25.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default none -->
 
 The plugin allows to check tags against a predefined list, in order to catch
@@ -377,8 +370,7 @@ The following settings are available for listings:
 
 #### <!-- md:setting config.listings -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.48.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `true` -->
 
 Use this setting to enable or disable listings. It is normally not necessary to
@@ -400,8 +392,7 @@ is enabled.
 
 #### <!-- md:setting config.listings_map -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.48.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default none -->
 
 Use this define listing configurations that you can then reference in listings
@@ -431,8 +422,7 @@ See the [listings section] for a list of all available settings.
 
 #### <!-- md:setting config.listings_sort_by -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.39.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `material.plugins.tags.item_title` -->
 
 Use this setting to specify a custom function for comparing listing items. By
@@ -463,8 +453,7 @@ or number representing the item, that is used for sorting, and reference it in
 
 #### <!-- md:setting config.listings_sort_reverse -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.39.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `false` -->
 
 Use this setting to reverse the order in which items are sorted when comparing
@@ -481,8 +470,7 @@ plugins:
 
 #### <!-- md:setting config.listings_tags_sort_by -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.48.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `material.plugins.tags.tag_name` -->
 
 Use this setting to specify a custom function for comparing tags in listings. By
@@ -503,8 +491,7 @@ or number representing the tag, that is used for sorting, and reference it in
 
 #### <!-- md:setting config.listings_tags_sort_reverse -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.48.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `false` -->
 
 Use this setting to reverse the order in which tags are sorted when comparing
@@ -521,8 +508,7 @@ plugins:
 
 #### <!-- md:setting config.listings_directive -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.48.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `material/tags` -->
 
 Use this setting to change the name of the directive the plugin will look for
@@ -777,8 +763,7 @@ The following settings are available:
 
 #### <!-- md:setting listing.scope -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.48.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default `false` -->
 
 This setting specifies whether the listing should only consider pages that are
@@ -879,8 +864,7 @@ setting on a per-listing basis:
 
 #### <!-- md:setting listing.include -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.48.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default none -->
 
 Use this setting to specify which tags should be included in the listing. Each
@@ -917,8 +901,7 @@ If this setting is left empty, all tags and pages are included.
 
 #### <!-- md:setting listing.exclude -->
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.48.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:default none -->
 
 Use this setting to specify which tags should be excluded from the listing. Each

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
 
 <!-- md:sponsors -->
 <!-- md:version insiders-4.51.0 -->

docs/reference/index.md

@@ -144,8 +144,7 @@ page status] to get you started.
 
 ### Setting the page `subtitle`
 
-<!-- md:sponsors -->
-<!-- md:version insiders-4.25.0 -->
+<!-- md:version 9.6.0 -->
 <!-- md:flag experimental -->
 
 Each page can define a subtitle, which is then rendered below the title as part