Prepare 9.6.0 release

squidfunk · Jan 31, 2025 · 1416697 · 1416697
1 parent 050c299
commit 1416697
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 33 deletions.
diff --git a/CHANGELOG b/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

diff --git a/docs/changelog/index.md b/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

diff --git a/docs/plugins/tags.md b/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,10 +160,9 @@ 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
 
 ---
 

diff --git a/docs/setup/setting-up-tags.md b/docs/setup/setting-up-tags.md
@@ -190,25 +190,12 @@ Following is a list of relevant tags:
 <!-- material/tags -->
 ```
 
-Then in your `mkdocs.yml` file, add the following.
-
-``` yaml
-plugins:
-  - tags:
-      tags_file: tags.md # (1)!
-```
-
-1. This setting is not necessary when using [Insiders].
-
-Note that the path to `tags.md` is relative to the `docs/` directory.
-
 The tags marker specifies the position of the tags index, i.e. it is
 replaced with the actual tags index when the page is rendered. You can include
 arbitrary content before and after the marker:
 
 [![Tags index][tags index enabled]][tags index enabled]
 
-  [tags.tags_file]: #tags-file
   [tags index enabled]: ../assets/screenshots/tags-index.png
 
 ### Advanced features

diff --git a/material/__init__.py b/material/__init__.py
@@ -18,4 +18,4 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 # IN THE SOFTWARE.
 
-__version__ = "9.5.50"
+__version__ = "9.6.0"
diff --git a/material/plugins/tags/config.py b/material/plugins/tags/config.py
@@ -67,7 +67,7 @@ class TagsConfig(Config):
     tags_compare_reverse = Deprecated(moved_to = "tags_sort_reverse")
     tags_pages_compare = Deprecated(moved_to = "listings_sort_by")
     tags_pages_compare_reverse = Deprecated(moved_to = "listings_sort_reverse")
-    tags_file = Deprecated(option_type = Type(str))
-    tags_extra_files = Deprecated(
-        option_type = DictOfItems(ListOfItems(Type(str)), default = {})
+    tags_file = Deprecated(
+        option_type = Type(str),
+        message = "This setting is not required anymore"
     )
diff --git a/material/templates/base.html b/material/templates/base.html
@@ -32,7 +32,7 @@
         <link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}">
       {% endif %}
       <link rel="icon" href="{{ config.theme.favicon | url }}">
-      <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.5.50">
+      <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.6.0">
     {% endblock %}
     {% block htmltitle %}
       {% if page.meta and page.meta.title %}

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "mkdocs-material",
-  "version": "9.5.50",
+  "version": "9.6.0",
   "description": "Documentation that simply works",
   "keywords": [
     "mkdocs",

diff --git a/src/plugins/tags/config.py b/src/plugins/tags/config.py
@@ -67,7 +67,7 @@ class TagsConfig(Config):
     tags_compare_reverse = Deprecated(moved_to = "tags_sort_reverse")
     tags_pages_compare = Deprecated(moved_to = "listings_sort_by")
     tags_pages_compare_reverse = Deprecated(moved_to = "listings_sort_reverse")
-    tags_file = Deprecated(option_type = Type(str))
-    tags_extra_files = Deprecated(
-        option_type = DictOfItems(ListOfItems(Type(str)), default = {})
+    tags_file = Deprecated(
+        option_type = Type(str),
+        message = "This setting is not required anymore"
     )