diff --git a/docs/insiders/index.md b/docs/insiders/index.md index 211aa5fcf..4829ccb71 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -333,7 +333,7 @@ can be used by all users. [Social cards]: ../setup/setting-up-social-cards.md [Code annotations: anchor links]: ../reference/code-blocks.md#anchor-links [Code annotations: strip comments]: ../reference/code-blocks.md#stripping-comments - [Tag icons]: ../setup/setting-up-tags.md#tag-icons + [Tag icons]: ../setup/setting-up-tags.md#tag-icons-and-identifiers [Table of contents anchor following]: ../setup/setting-up-navigation.md#anchor-following #### $ 7,000 – Royal Gold diff --git a/docs/schema/extra.json b/docs/schema/extra.json index 67a837bb7..b67d0ce30 100644 --- a/docs/schema/extra.json +++ b/docs/schema/extra.json @@ -299,12 +299,12 @@ }, "tags": { "title": "Tag identifiers", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers", "type": "object", "patternProperties": { ".*": { "title": "Tag identifier mapping", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers", "pattern": "^[\\w-]+$" } } diff --git a/docs/schema/theme.json b/docs/schema/theme.json index 6ca89d158..9553e7145 100644 --- a/docs/schema/theme.json +++ b/docs/schema/theme.json @@ -541,7 +541,7 @@ }, "tag": { "title": "Tag icon", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons", + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers", "type": "object", "patternProperties": { "^\\w+$": { diff --git a/docs/setup/ensuring-data-privacy.md b/docs/setup/ensuring-data-privacy.md index 7a2c4d962..d9fb37a3e 100644 --- a/docs/setup/ensuring-data-privacy.md +++ b/docs/setup/ensuring-data-privacy.md @@ -171,8 +171,8 @@ The following configuration options are available: [`enabled`](#+privacy.enabled){ #+privacy.enabled } : :octicons-milestone-24: Default: `true` – This option specifies whether - the plugin is enabled when building your project. If you want to switch - the plugin off, e.g. for local builds, use an [environment variable]: + the plugin is enabled when building your project. If you want to speed up + local builds, you can use an [environment variable]: ``` yaml plugins: diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md index d102224bd..362932fb8 100644 --- a/docs/setup/setting-up-a-blog.md +++ b/docs/setup/setting-up-a-blog.md @@ -77,13 +77,13 @@ The following configuration options are available: [`enabled`](#+blog.enabled){ #+blog.enabled } : :octicons-milestone-24: Default: `true` – This option specifies whether - the plugin is enabled when building your project. If you want to switch - the plugin off, you can disable it with the following lines: + the plugin is enabled when building your project. If you want to speed up + local builds, you can use an [environment variable]: ``` yaml plugins: - blog: - enabled: false + enabled: !ENV [CI, false] ``` [`blog_dir`](#+blog.blog_dir){ #+blog.blog_dir } @@ -824,13 +824,13 @@ The following configuration options are supported: [`enabled`](#+rss.enabled){ #+rss.enabled } : :octicons-milestone-24: Default: `true` – This option specifies whether - the plugin is enabled when building your project. If you want to switch - the plugin off, you can disable it with the following lines: + the plugin is enabled when building your project. If you want to speed up + local builds, you can use an [environment variable]: ``` yaml plugins: - rss: - enabled: false + enabled: !ENV [CI, false] ``` [`match_path`](#+rss.match_path){ #+rss.match_path } diff --git a/docs/setup/setting-up-tags.md b/docs/setup/setting-up-tags.md index f488bf540..36b417c38 100644 --- a/docs/setup/setting-up-tags.md +++ b/docs/setup/setting-up-tags.md @@ -33,13 +33,13 @@ The following configuration options are available: [`enabled`](#+tags.enabled){ #+tags.enabled } : :octicons-milestone-24: Default: `true` – This option specifies whether - the plugin is enabled when building your project. If you want to switch - the plugin off, you can disable it with the following lines: + the plugin is enabled when building your project. If you want to speed up + local builds, you can use an [environment variable]: ``` yaml plugins: - - tags: - enabled: false + - privacy: + enabled: !ENV [CI, false] ``` [`tags_file`](#+tags.tags_file){ #+tags.tags_file } @@ -95,7 +95,8 @@ The following configuration options are available: at least one of the tags `HTML5`, `JavaScript` or `CSS` will be included in the additional tags index on `web.md`. - See #3864 for more information. + Note that the values listed under each tags extra file must be alphanumeric + [tag identifiers], not tags themselves. See #3864 for more information. [`tags_slugify`](#+tags.tags_slugify){ #+tags.tags_slugify } @@ -153,11 +154,12 @@ The following configuration options are available: ``` [Tags support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.2.0 + [environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables [Insiders]: ../insiders/index.md - [tag identifiers]: #tag-icons + [tag identifiers]: #tag-icons-and-identifiers [Python Markdown Extensions]: https://facelessuser.github.io/pymdown-extensions/extras/slugs/ -### Tag icons +### Tag icons and identifiers [:octicons-tag-24: 8.5.0][Tag icons support] · :octicons-beaker-24: Experimental