mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2025-02-14 09:22:34 +01:00
Prepare 9.6.0 release
This commit is contained in:
parent
050c299ec8
commit
1416697c6b
11
CHANGELOG
11
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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
||||
---
|
||||
|
||||
|
@ -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
|
||||
|
@ -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"
|
||||
|
@ -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"
|
||||
)
|
||||
|
@ -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 %}
|
||||
|
4
package-lock.json
generated
4
package-lock.json
generated
@ -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",
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "mkdocs-material",
|
||||
"version": "9.5.50",
|
||||
"version": "9.6.0",
|
||||
"description": "Documentation that simply works",
|
||||
"keywords": [
|
||||
"mkdocs",
|
||||
|
@ -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"
|
||||
)
|
||||
|
Loading…
x
Reference in New Issue
Block a user