Skip to content

Commit 1416697

Browse files
committedJan 31, 2025··
Prepare 9.6.0 release
1 parent 050c299 commit 1416697

File tree

10 files changed

+43
-33
lines changed

10 files changed

+43
-33
lines changed
 

‎CHANGELOG

+11
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
mkdocs-material-9.6.0 (2025-01-31)
2+
3+
* Added meta plugin
4+
* Rewrite of the tags plugin
5+
* Added support for allow lists in tags plugin
6+
* Added support for and custom sorting in tags plugin
7+
* Added support for related links in blog plugin
8+
* Added support for custom index pages in blog plugin
9+
* Added support for navigation subtitles
10+
* Fixed #7924: Anchors might require two clicks when using instant navigation
11+
112
mkdocs-material-9.5.50 (2025-01-18)
213

314
* Fixed #7913: Social plugin renders attribute lists in page title

‎docs/changelog/index.md

+11
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
## Material for MkDocs
44

5+
### 9.6.0 <small>January 31, 2025</small> { id="9.6.0" }
6+
7+
- Added meta plugin
8+
- Rewrite of the tags plugin
9+
- Added support for allow lists in tags plugin
10+
- Added support for and custom sorting in tags plugin
11+
- Added support for related links in blog plugin
12+
- Added support for custom index pages in blog plugin
13+
- Added support for navigation subtitles
14+
- Fixed #7924: Anchors might require two clicks when using instant navigation
15+
516
### 9.5.50 <small>January 18, 2025</small> { id="9.5.50" }
617

718
- Fixed #7913: Social plugin renders attribute lists in page title

‎docs/plugins/tags.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -134,12 +134,14 @@ is enabled.
134134
<!-- md:version 8.2.0 -->
135135
<!-- md:default none -->
136136

137-
!!! info "This setting is not needed in [Insiders]"
137+
!!! warning "This setting is deprecated"
138138

139-
Insiders ships a __ground up rewrite of the tags plugin__ which is infinitely
140-
more powerful than the current version in the community edition. It allows
141-
for an arbitrary number of tags indexes (listings), [scoped listings],
142-
[shadow tags], [nested tags], and much more.
139+
As of version <!-- md:version 9.6.0 -->, this setting is deprecated, as this
140+
version ships a __ground up rewrite of the tags plugin__ which is much more
141+
powerful than the previous version. Tags [listings] can be used on any page
142+
now.
143+
144+
<div style="opacity: 0.5" markdown>
143145

144146
Use this setting to specify the location of the tags index, which is the page
145147
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.
158160

159161
The provided path is resolved from the [`docs` directory][mkdocs.docs_dir].
160162

161-
[Insiders]: ../insiders/index.md
162-
[scoped listings]: ../setup/setting-up-tags.md#scoped-listings
163-
[shadow tags]: ../setup/setting-up-tags.md#shadow-tags
164-
[nested tags]: ../setup/setting-up-tags.md#nested-tags
163+
</div>
164+
165+
[listings]: ../setup/setting-up-tags.md#adding-a-tags-index
165166

166167
---
167168

‎docs/setup/setting-up-tags.md

-13
Original file line numberDiff line numberDiff line change
@@ -190,25 +190,12 @@ Following is a list of relevant tags:
190190
<!-- material/tags -->
191191
```
192192

193-
Then in your `mkdocs.yml` file, add the following.
194-
195-
``` yaml
196-
plugins:
197-
- tags:
198-
tags_file: tags.md # (1)!
199-
```
200-
201-
1. This setting is not necessary when using [Insiders].
202-
203-
Note that the path to `tags.md` is relative to the `docs/` directory.
204-
205193
The tags marker specifies the position of the tags index, i.e. it is
206194
replaced with the actual tags index when the page is rendered. You can include
207195
arbitrary content before and after the marker:
208196

209197
[![Tags index][tags index enabled]][tags index enabled]
210198

211-
[tags.tags_file]: #tags-file
212199
[tags index enabled]: ../assets/screenshots/tags-index.png
213200

214201
### Advanced features

‎material/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@
1818
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
1919
# IN THE SOFTWARE.
2020

21-
__version__ = "9.5.50"
21+
__version__ = "9.6.0"

‎material/plugins/tags/config.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ class TagsConfig(Config):
6767
tags_compare_reverse = Deprecated(moved_to = "tags_sort_reverse")
6868
tags_pages_compare = Deprecated(moved_to = "listings_sort_by")
6969
tags_pages_compare_reverse = Deprecated(moved_to = "listings_sort_reverse")
70-
tags_file = Deprecated(option_type = Type(str))
71-
tags_extra_files = Deprecated(
72-
option_type = DictOfItems(ListOfItems(Type(str)), default = {})
70+
tags_file = Deprecated(
71+
option_type = Type(str),
72+
message = "This setting is not required anymore"
7373
)

‎material/templates/base.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}">
3333
{% endif %}
3434
<link rel="icon" href="{{ config.theme.favicon | url }}">
35-
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.5.50">
35+
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.6.0">
3636
{% endblock %}
3737
{% block htmltitle %}
3838
{% if page.meta and page.meta.title %}

‎package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mkdocs-material",
3-
"version": "9.5.50",
3+
"version": "9.6.0",
44
"description": "Documentation that simply works",
55
"keywords": [
66
"mkdocs",

‎src/plugins/tags/config.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ class TagsConfig(Config):
6767
tags_compare_reverse = Deprecated(moved_to = "tags_sort_reverse")
6868
tags_pages_compare = Deprecated(moved_to = "listings_sort_by")
6969
tags_pages_compare_reverse = Deprecated(moved_to = "listings_sort_reverse")
70-
tags_file = Deprecated(option_type = Type(str))
71-
tags_extra_files = Deprecated(
72-
option_type = DictOfItems(ListOfItems(Type(str)), default = {})
70+
tags_file = Deprecated(
71+
option_type = Type(str),
72+
message = "This setting is not required anymore"
7373
)

0 commit comments

Comments
 (0)
Please sign in to comment.