1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2025-02-15 01:42:39 +01:00

Prepare 9.6.0 release

This commit is contained in:
squidfunk 2025-01-31 11:02:40 +07:00
parent 050c299ec8
commit 1416697c6b
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
10 changed files with 43 additions and 33 deletions

View File

@ -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) mkdocs-material-9.5.50 (2025-01-18)
* Fixed #7913: Social plugin renders attribute lists in page title * Fixed #7913: Social plugin renders attribute lists in page title

View File

@ -2,6 +2,17 @@
## Material for MkDocs ## 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" } ### 9.5.50 <small>January 18, 2025</small> { id="9.5.50" }
- Fixed #7913: Social plugin renders attribute lists in page title - Fixed #7913: Social plugin renders attribute lists in page title

View File

@ -134,12 +134,14 @@ is enabled.
<!-- md:version 8.2.0 --> <!-- md:version 8.2.0 -->
<!-- md:default none --> <!-- 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 As of version <!-- md:version 9.6.0 -->, this setting is deprecated, as this
more powerful than the current version in the community edition. It allows version ships a __ground up rewrite of the tags plugin__ which is much more
for an arbitrary number of tags indexes (listings), [scoped listings], powerful than the previous version. Tags [listings] can be used on any page
[shadow tags], [nested tags], and much more. now.
<div style="opacity: 0.5" markdown>
Use this setting to specify the location of the tags index, which is the page 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 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]. The provided path is resolved from the [`docs` directory][mkdocs.docs_dir].
[Insiders]: ../insiders/index.md </div>
[scoped listings]: ../setup/setting-up-tags.md#scoped-listings
[shadow tags]: ../setup/setting-up-tags.md#shadow-tags [listings]: ../setup/setting-up-tags.md#adding-a-tags-index
[nested tags]: ../setup/setting-up-tags.md#nested-tags
--- ---

View File

@ -190,25 +190,12 @@ Following is a list of relevant tags:
<!-- material/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 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 replaced with the actual tags index when the page is rendered. You can include
arbitrary content before and after the marker: arbitrary content before and after the marker:
[![Tags index][tags index enabled]][tags index enabled] [![Tags index][tags index enabled]][tags index enabled]
[tags.tags_file]: #tags-file
[tags index enabled]: ../assets/screenshots/tags-index.png [tags index enabled]: ../assets/screenshots/tags-index.png
### Advanced features ### Advanced features

View File

@ -18,4 +18,4 @@
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE. # IN THE SOFTWARE.
__version__ = "9.5.50" __version__ = "9.6.0"

View File

@ -67,7 +67,7 @@ class TagsConfig(Config):
tags_compare_reverse = Deprecated(moved_to = "tags_sort_reverse") tags_compare_reverse = Deprecated(moved_to = "tags_sort_reverse")
tags_pages_compare = Deprecated(moved_to = "listings_sort_by") tags_pages_compare = Deprecated(moved_to = "listings_sort_by")
tags_pages_compare_reverse = Deprecated(moved_to = "listings_sort_reverse") tags_pages_compare_reverse = Deprecated(moved_to = "listings_sort_reverse")
tags_file = Deprecated(option_type = Type(str)) tags_file = Deprecated(
tags_extra_files = Deprecated( option_type = Type(str),
option_type = DictOfItems(ListOfItems(Type(str)), default = {}) message = "This setting is not required anymore"
) )

View File

@ -32,7 +32,7 @@
<link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}"> <link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}">
{% endif %} {% endif %}
<link rel="icon" href="{{ config.theme.favicon | url }}"> <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 %} {% endblock %}
{% block htmltitle %} {% block htmltitle %}
{% if page.meta and page.meta.title %} {% if page.meta and page.meta.title %}

4
package-lock.json generated
View File

@ -1,12 +1,12 @@
{ {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "9.5.50", "version": "9.6.0",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "9.5.50", "version": "9.6.0",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"clipboard": "^2.0.11", "clipboard": "^2.0.11",

View File

@ -1,6 +1,6 @@
{ {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "9.5.50", "version": "9.6.0",
"description": "Documentation that simply works", "description": "Documentation that simply works",
"keywords": [ "keywords": [
"mkdocs", "mkdocs",

View File

@ -67,7 +67,7 @@ class TagsConfig(Config):
tags_compare_reverse = Deprecated(moved_to = "tags_sort_reverse") tags_compare_reverse = Deprecated(moved_to = "tags_sort_reverse")
tags_pages_compare = Deprecated(moved_to = "listings_sort_by") tags_pages_compare = Deprecated(moved_to = "listings_sort_by")
tags_pages_compare_reverse = Deprecated(moved_to = "listings_sort_reverse") tags_pages_compare_reverse = Deprecated(moved_to = "listings_sort_reverse")
tags_file = Deprecated(option_type = Type(str)) tags_file = Deprecated(
tags_extra_files = Deprecated( option_type = Type(str),
option_type = DictOfItems(ListOfItems(Type(str)), default = {}) message = "This setting is not required anymore"
) )