From 743166e74a17a7b01b89b0b7df742cbc9a8e9e04 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Thu, 7 Jul 2022 18:59:59 +0200 Subject: [PATCH] Updated Insiders changelog --- CHANGELOG | 5 +++++ docs/insiders/changelog.md | 5 +++++ docs/insiders/index.md | 7 ++++-- docs/reference/content-tabs.md | 2 +- docs/schema/plugins/tags.json | 14 ++++++++++++ docs/setup/setting-up-tags.md | 39 ++++++++++++++++++++++++++++++++++ 6 files changed, 69 insertions(+), 3 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index a5b2b0a28..d41a905aa 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,8 @@ +mkdocs-material-8.3.9+insiders-4.20.0 (2022-07-07) + + * Added support for additional tags indexes + * Fixed #4100: Tag icons not shown in tags index + mkdocs-material-8.3.9+insiders-4.19.2 (2022-07-04) * Fixed #4051: Privacy plugin fails if symlinking isn't allowed on Windows diff --git a/docs/insiders/changelog.md b/docs/insiders/changelog.md index 7f25cb0c4..862b1dd98 100644 --- a/docs/insiders/changelog.md +++ b/docs/insiders/changelog.md @@ -6,6 +6,11 @@ template: overrides/main.html ## Material for MkDocs Insiders +### 4.20.0 _ July 7, 2022 { id="4.20.0" } + +- Added support for additional tags indexes +- Fixed #4100: Tag icons not shown in tags index + ### 4.19.2 _ July 4, 2022 { id="4.19.2" } - Fixed #4051: Privacy plugin fails if symlinking isn't allowed on Windows diff --git a/docs/insiders/index.md b/docs/insiders/index.md index 1ebf45a79..95821d260 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -82,14 +82,15 @@ a handful of them, [thanks to our awesome sponsors]! ## What's in for me? The moment you [become a sponsor][how to become a sponsor], you'll get __immediate -access to 25 additional features__ that you can start using right away, and +access to 26 additional features__ that you can start using right away, and which are currently exclusively available to sponsors:
+- [x] [Additional tags indexes] :material-alert-decagram:{ .mdx-pulse title="Added on July 7, 2022" } - [x] [Document contributors] :material-alert-decagram:{ .mdx-pulse title="Added on June 24, 2022" } - [x] [Automatic light / dark mode] :material-alert-decagram:{ .mdx-pulse title="Added on June 11, 2022" } -- [x] [Content tabs: anchor links] :material-alert-decagram:{ .mdx-pulse title="Added on June 4, 2022" } +- [x] [Content tabs: anchor links] - [x] [Navigation pruning] - [x] [Tooltips] - [x] [Chinese search support] @@ -299,9 +300,11 @@ are released for general availability. #### $ 16,000 – Chipotle +- [x] [Additional tags indexes] - [ ] [Instant previews] - [ ] ... more to be announced + [Additional tags indexes]: ../setup/setting-up-tags.md#tags-extra-files [Instant previews]: https://twitter.com/squidfunk/status/1466794654213492743 ### Goals completed diff --git a/docs/reference/content-tabs.md b/docs/reference/content-tabs.md index a55baa447..8ec36c7f5 100644 --- a/docs/reference/content-tabs.md +++ b/docs/reference/content-tabs.md @@ -31,7 +31,7 @@ See additional configuration options: [SuperFences]: ../setup/extensions/python-markdown-extensions.md#superfences [Tabbed]: ../setup/extensions/python-markdown-extensions.md#tabbed -### Anchor links :material-alert-decagram:{ .mdx-pulse title="Added on June 4, 2022" } +### Anchor links [:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: insiders-4.17.0][Insiders] · diff --git a/docs/schema/plugins/tags.json b/docs/schema/plugins/tags.json index b24dd29a6..3688d73e1 100644 --- a/docs/schema/plugins/tags.json +++ b/docs/schema/plugins/tags.json @@ -20,6 +20,20 @@ "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tags-file", "pattern": "\\.md$", "default": "tags.md" + }, + "tags_extra_files": { + "title": "Markdown files to render additional tags indexes", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tags-extra-files", + "type": "object", + "patternProperties": { + "\\.md$": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false } }, "additionalProperties": false diff --git a/docs/setup/setting-up-tags.md b/docs/setup/setting-up-tags.md index 35939866a..7df1c35a7 100644 --- a/docs/setup/setting-up-tags.md +++ b/docs/setup/setting-up-tags.md @@ -48,7 +48,46 @@ The following configuration options are available: of `mkdocs.yml`. Note, however, that this options is not required – only use it if you want a tags index page. +`tags_extra_files`{ #tags-extra-files } :material-alert-decagram:{ .mdx-pulse title="Added on July 7, 2022" } + +: [:octicons-tag-24: insiders-4.20.0][Insiders] · :octicons-milestone-24: + Default: _none_ – This option allows to define additional pages to render + subsets of the [tags index], in order to provide scoped tags indexes for + specific sections: + + ``` yaml + plugins: + - tags: + tags_extra_files: + compatibility.md: + - compat #(1)! + web.md: + - html + - js + - css + ``` + + 1. Each page can be assigned a list of [tag identifiers], which must be + defined as part of `extra.tags` in `mkdocs.yml`: + + ``` yaml + extra: + tags: + Compatibility: compat + HTML5: html + JavaScript: js + CSS: css + ``` + + In this example, all pages with the tag `Compatibility` will be included + in the additional tags index on `compatibility.md`, all pages defining + at least one of the tags `HTML5`, `JavaScript` or `CSS` will be included + in the additional tags index on `web.md`. + + See #3864 for additional use cases. + [tags support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.2.0 + [tag identifiers]: #tag-icons ### Tag icons