From 1416697c6b27725859d522c8763914c2b1fb1615 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Fri, 31 Jan 2025 11:02:40 +0700 Subject: [PATCH] Prepare 9.6.0 release --- CHANGELOG | 11 +++++++++++ docs/changelog/index.md | 11 +++++++++++ docs/plugins/tags.md | 19 ++++++++++--------- docs/setup/setting-up-tags.md | 13 ------------- material/__init__.py | 2 +- material/plugins/tags/config.py | 6 +++--- material/templates/base.html | 2 +- package-lock.json | 4 ++-- package.json | 2 +- src/plugins/tags/config.py | 6 +++--- 10 files changed, 43 insertions(+), 33 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index dda40a92a..96e455a22 100644 --- 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 index 57bb56972..221d62da4 100644 --- a/docs/changelog/index.md +++ b/docs/changelog/index.md @@ -2,6 +2,17 @@ ## Material for MkDocs +### 9.6.0 January 31, 2025 { 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 January 18, 2025 { 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 index 0105d8ff2..808ae6578 100644 --- a/docs/plugins/tags.md +++ b/docs/plugins/tags.md @@ -134,12 +134,14 @@ is enabled. -!!! 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 , 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. + +
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 +
+ + [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 index 74cd69c26..af4877a6e 100644 --- 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: ``` -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 index 3a08ca845..8a19d9e6b 100644 --- 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 index 4d48a3836..cd069261c 100644 --- 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 index 9c008d9f0..7921c751e 100644 --- a/material/templates/base.html +++ b/material/templates/base.html @@ -32,7 +32,7 @@ {% endif %} - + {% endblock %} {% block htmltitle %} {% if page.meta and page.meta.title %} diff --git a/package-lock.json b/package-lock.json index 0e6a75bc4..9787bab21 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "mkdocs-material", - "version": "9.5.50", + "version": "9.6.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "mkdocs-material", - "version": "9.5.50", + "version": "9.6.0", "license": "MIT", "dependencies": { "clipboard": "^2.0.11", diff --git a/package.json b/package.json index ccee1ca17..0ccc4bfa9 100644 --- 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 index 4d48a3836..cd069261c 100644 --- 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" )