mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Documentation
This commit is contained in:
@@ -333,7 +333,7 @@ can be used by all users.
|
|||||||
[Social cards]: ../setup/setting-up-social-cards.md
|
[Social cards]: ../setup/setting-up-social-cards.md
|
||||||
[Code annotations: anchor links]: ../reference/code-blocks.md#anchor-links
|
[Code annotations: anchor links]: ../reference/code-blocks.md#anchor-links
|
||||||
[Code annotations: strip comments]: ../reference/code-blocks.md#stripping-comments
|
[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
|
[Table of contents anchor following]: ../setup/setting-up-navigation.md#anchor-following
|
||||||
|
|
||||||
#### $ 7,000 – Royal Gold
|
#### $ 7,000 – Royal Gold
|
||||||
|
|||||||
@@ -299,12 +299,12 @@
|
|||||||
},
|
},
|
||||||
"tags": {
|
"tags": {
|
||||||
"title": "Tag identifiers",
|
"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",
|
"type": "object",
|
||||||
"patternProperties": {
|
"patternProperties": {
|
||||||
".*": {
|
".*": {
|
||||||
"title": "Tag identifier mapping",
|
"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-]+$"
|
"pattern": "^[\\w-]+$"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -541,7 +541,7 @@
|
|||||||
},
|
},
|
||||||
"tag": {
|
"tag": {
|
||||||
"title": "Tag icon",
|
"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",
|
"type": "object",
|
||||||
"patternProperties": {
|
"patternProperties": {
|
||||||
"^\\w+$": {
|
"^\\w+$": {
|
||||||
|
|||||||
@@ -171,8 +171,8 @@ The following configuration options are available:
|
|||||||
[`enabled`](#+privacy.enabled){ #+privacy.enabled }
|
[`enabled`](#+privacy.enabled){ #+privacy.enabled }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
||||||
the plugin is enabled when building your project. If you want to switch
|
the plugin is enabled when building your project. If you want to speed up
|
||||||
the plugin off, e.g. for local builds, use an [environment variable]:
|
local builds, you can use an [environment variable]:
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
plugins:
|
plugins:
|
||||||
|
|||||||
@@ -77,13 +77,13 @@ The following configuration options are available:
|
|||||||
[`enabled`](#+blog.enabled){ #+blog.enabled }
|
[`enabled`](#+blog.enabled){ #+blog.enabled }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
||||||
the plugin is enabled when building your project. If you want to switch
|
the plugin is enabled when building your project. If you want to speed up
|
||||||
the plugin off, you can disable it with the following lines:
|
local builds, you can use an [environment variable]:
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
plugins:
|
plugins:
|
||||||
- blog:
|
- blog:
|
||||||
enabled: false
|
enabled: !ENV [CI, false]
|
||||||
```
|
```
|
||||||
|
|
||||||
[`blog_dir`](#+blog.blog_dir){ #+blog.blog_dir }
|
[`blog_dir`](#+blog.blog_dir){ #+blog.blog_dir }
|
||||||
@@ -824,13 +824,13 @@ The following configuration options are supported:
|
|||||||
[`enabled`](#+rss.enabled){ #+rss.enabled }
|
[`enabled`](#+rss.enabled){ #+rss.enabled }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
||||||
the plugin is enabled when building your project. If you want to switch
|
the plugin is enabled when building your project. If you want to speed up
|
||||||
the plugin off, you can disable it with the following lines:
|
local builds, you can use an [environment variable]:
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
plugins:
|
plugins:
|
||||||
- rss:
|
- rss:
|
||||||
enabled: false
|
enabled: !ENV [CI, false]
|
||||||
```
|
```
|
||||||
|
|
||||||
[`match_path`](#+rss.match_path){ #+rss.match_path }
|
[`match_path`](#+rss.match_path){ #+rss.match_path }
|
||||||
|
|||||||
@@ -33,13 +33,13 @@ The following configuration options are available:
|
|||||||
[`enabled`](#+tags.enabled){ #+tags.enabled }
|
[`enabled`](#+tags.enabled){ #+tags.enabled }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
||||||
the plugin is enabled when building your project. If you want to switch
|
the plugin is enabled when building your project. If you want to speed up
|
||||||
the plugin off, you can disable it with the following lines:
|
local builds, you can use an [environment variable]:
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
plugins:
|
plugins:
|
||||||
- tags:
|
- privacy:
|
||||||
enabled: false
|
enabled: !ENV [CI, false]
|
||||||
```
|
```
|
||||||
|
|
||||||
[`tags_file`](#+tags.tags_file){ #+tags.tags_file }
|
[`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
|
at least one of the tags `HTML5`, `JavaScript` or `CSS` will be included
|
||||||
in the additional tags index on `web.md`.
|
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 }
|
[`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
|
[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
|
[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/
|
[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-tag-24: 8.5.0][Tag icons support] ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|||||||
Reference in New Issue
Block a user