mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Documentation
This commit is contained in:
parent
081b63f0c1
commit
7e56e38810
2
.github/ISSUE_TEMPLATE/bug.yml
vendored
2
.github/ISSUE_TEMPLATE/bug.yml
vendored
@ -50,7 +50,7 @@ body:
|
|||||||
description: >-
|
description: >-
|
||||||
Please create a __minimal reproduction__ for the bug. First, read our
|
Please create a __minimal reproduction__ for the bug. First, read our
|
||||||
[reproduction guide](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/)
|
[reproduction guide](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/)
|
||||||
that explains the necessary steps, then use the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/#built-in-info-plugin) (mandatory) to create a self-contained
|
that explains the necessary steps, then use the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/bug-report/reproduction/#creating-a-zip-file) (mandatory) to create a self-contained
|
||||||
.zip file with the reproduction. Without a reproduction, it can be
|
.zip file with the reproduction. Without a reproduction, it can be
|
||||||
challenging to fix the bug. [More](https://squidfunk.github.io/mkdocs-material/bug-report/#reproduction)
|
challenging to fix the bug. [More](https://squidfunk.github.io/mkdocs-material/bug-report/#reproduction)
|
||||||
placeholder: |-
|
placeholder: |-
|
||||||
|
@ -265,7 +265,7 @@ automatically upload it to GitHub.
|
|||||||
have trouble creating repositories.
|
have trouble creating repositories.
|
||||||
|
|
||||||
[Create reproduction]: reproduction.md
|
[Create reproduction]: reproduction.md
|
||||||
[built-in info plugin]: reproduction.md#built-in-info-plugin
|
[built-in info plugin]: reproduction.md#creating-a-zip-file
|
||||||
|
|
||||||
### Steps to reproduce
|
### Steps to reproduce
|
||||||
|
|
||||||
|
@ -34,8 +34,7 @@ See additional configuration options:
|
|||||||
|
|
||||||
### Admonition icons
|
### Admonition icons
|
||||||
|
|
||||||
[:octicons-tag-24: 8.3.0][Admonition icons support] ·
|
[:octicons-tag-24: 8.3.0][Admonition icons support]
|
||||||
:octicons-beaker-24: Experimental
|
|
||||||
|
|
||||||
Each of the supported admonition types has a distinct icon, which can be changed
|
Each of the supported admonition types has a distinct icon, which can be changed
|
||||||
to any icon bundled with the theme, or even a [custom icon]. Add the following
|
to any icon bundled with the theme, or even a [custom icon]. Add the following
|
||||||
@ -230,9 +229,6 @@ Adding a `+` after the `???` token renders the block expanded:
|
|||||||
|
|
||||||
### Inline blocks
|
### Inline blocks
|
||||||
|
|
||||||
[:octicons-tag-24: 7.0.0][Inline blocks support] ·
|
|
||||||
:octicons-beaker-24: Experimental
|
|
||||||
|
|
||||||
Admonitions can also be rendered as inline blocks (i.e. for sidebars), placing
|
Admonitions can also be rendered as inline blocks (i.e. for sidebars), placing
|
||||||
them to the right using the `inline` + `end` modifiers, or to the left using
|
them to the right using the `inline` + `end` modifiers, or to the left using
|
||||||
only the `inline` modifier:
|
only the `inline` modifier:
|
||||||
@ -282,8 +278,6 @@ prior to the content block you want to place them beside. If there's
|
|||||||
insufficient space to render the admonition next to the block, the admonition
|
insufficient space to render the admonition next to the block, the admonition
|
||||||
will stretch to the full width of the viewport, e.g. on mobile viewports.
|
will stretch to the full width of the viewport, e.g. on mobile viewports.
|
||||||
|
|
||||||
[Inline blocks support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.0.0
|
|
||||||
|
|
||||||
### Supported types
|
### Supported types
|
||||||
|
|
||||||
Following is a list of type qualifiers provided by Material for MkDocs, whereas
|
Following is a list of type qualifiers provided by Material for MkDocs, whereas
|
||||||
|
@ -75,8 +75,7 @@ or to the [publishing guide for Insiders][tab_2].
|
|||||||
### Linked content tabs
|
### Linked content tabs
|
||||||
|
|
||||||
[:octicons-tag-24: 8.3.0][Linked content tabs support] ·
|
[:octicons-tag-24: 8.3.0][Linked content tabs support] ·
|
||||||
:octicons-unlock-24: Feature flag ·
|
:octicons-unlock-24: Feature flag
|
||||||
:octicons-beaker-24: Experimental
|
|
||||||
|
|
||||||
When enabled, all content tabs across the whole documentation site will be
|
When enabled, all content tabs across the whole documentation site will be
|
||||||
linked and switch to the same label when the user clicks on a tab. Add the
|
linked and switch to the same label when the user clicks on a tab. Add the
|
||||||
|
@ -13,8 +13,7 @@ popular and flexible solution for drawing diagrams.
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
[:octicons-tag-24: 8.2.0][Diagrams support] ·
|
[:octicons-tag-24: 8.2.0][Diagrams support]
|
||||||
:octicons-beaker-24: Experimental
|
|
||||||
|
|
||||||
This configuration enables native support for [Mermaid.js] diagrams. Material
|
This configuration enables native support for [Mermaid.js] diagrams. Material
|
||||||
for MkDocs will automatically initialize the JavaScript runtime when a page
|
for MkDocs will automatically initialize the JavaScript runtime when a page
|
||||||
|
@ -154,8 +154,7 @@ browsers without support:
|
|||||||
|
|
||||||
### Light and dark mode
|
### Light and dark mode
|
||||||
|
|
||||||
[:octicons-tag-24: 8.1.1][Light and dark mode support] ·
|
[:octicons-tag-24: 8.1.1][Light and dark mode support]
|
||||||
:octicons-beaker-24: Experimental
|
|
||||||
|
|
||||||
If you added a [color palette toggle] and want to show different images for
|
If you added a [color palette toggle] and want to show different images for
|
||||||
light and dark color schemes, you can append a `#only-light` or `#only-dark`
|
light and dark color schemes, you can append a `#only-light` or `#only-dark`
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
"title": "Built-in info plugin",
|
"title": "Built-in info plugin",
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#built-in-info-plugin",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#creating-a-zip-file",
|
||||||
"enum": [
|
"enum": [
|
||||||
"info"
|
"info"
|
||||||
]
|
]
|
||||||
@ -12,12 +12,12 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"info": {
|
"info": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#built-in-info-plugin",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#creating-a-zip-file",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"enabled": {
|
"enabled": {
|
||||||
"title": "Enable plugin",
|
"title": "Enable plugin",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#+info.enabled",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reporting-an-issue/#creating-a-zip-file",
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": true
|
"default": true
|
||||||
}
|
}
|
||||||
|
@ -105,8 +105,7 @@ the default slug function works. Consider using a [Unicode-aware slug function].
|
|||||||
### Site language selector
|
### Site language selector
|
||||||
|
|
||||||
[:octicons-tag-24: 7.0.0][Site language selector support] ·
|
[:octicons-tag-24: 7.0.0][Site language selector support] ·
|
||||||
:octicons-milestone-24: Default: _none_ ·
|
:octicons-milestone-24: Default: _none_
|
||||||
:octicons-beaker-24: Experimental
|
|
||||||
|
|
||||||
If your documentation is available in multiple languages, a language selector
|
If your documentation is available in multiple languages, a language selector
|
||||||
pointing to those languages can be added to the header. Alternate languages
|
pointing to those languages can be added to the header. Alternate languages
|
||||||
|
@ -37,8 +37,7 @@ especially useful for large documentation sites.
|
|||||||
### Anchor tracking
|
### Anchor tracking
|
||||||
|
|
||||||
[:octicons-tag-24: 8.0.0][Anchor tracking support] ·
|
[:octicons-tag-24: 8.0.0][Anchor tracking support] ·
|
||||||
:octicons-unlock-24: Feature flag ·
|
:octicons-unlock-24: Feature flag
|
||||||
:octicons-beaker-24: Experimental
|
|
||||||
|
|
||||||
When anchor tracking is enabled, the URL in the address bar is automatically
|
When anchor tracking is enabled, the URL in the address bar is automatically
|
||||||
updated with the active anchor as highlighted in the table of contents. Add the
|
updated with the active anchor as highlighted in the table of contents. Add the
|
||||||
|
@ -67,8 +67,7 @@ following lines to `mkdocs.yml`:
|
|||||||
### Was this page helpful?
|
### Was this page helpful?
|
||||||
|
|
||||||
[:octicons-tag-24: 8.4.0][Was this page helpful? support] ·
|
[:octicons-tag-24: 8.4.0][Was this page helpful? support] ·
|
||||||
:octicons-milestone-24: Default: _none_ ·
|
:octicons-milestone-24: Default: _none_
|
||||||
:octicons-beaker-24: Experimental
|
|
||||||
|
|
||||||
A simple [feedback widget] can be included at the bottom of each page,
|
A simple [feedback widget] can be included at the bottom of each page,
|
||||||
encouraging users to give instant feedback whether a page was helpful or not.
|
encouraging users to give instant feedback whether a page was helpful or not.
|
||||||
|
@ -12,8 +12,7 @@ can help to discover relevant information faster.
|
|||||||
### Built-in tags plugin
|
### Built-in tags plugin
|
||||||
|
|
||||||
[:octicons-tag-24: 8.2.0][Tags support] ·
|
[:octicons-tag-24: 8.2.0][Tags support] ·
|
||||||
:octicons-cpu-24: Plugin ·
|
:octicons-cpu-24: Plugin
|
||||||
:octicons-beaker-24: Experimental
|
|
||||||
|
|
||||||
The built-in tags plugin adds the ability to categorize any page with tags
|
The built-in tags plugin adds the ability to categorize any page with tags
|
||||||
as part of the front matter of the page. In order to add support for tags, add
|
as part of the front matter of the page. In order to add support for tags, add
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
Upgrade to the latest version with:
|
Upgrade to the latest version with:
|
||||||
|
|
||||||
```
|
```
|
||||||
pip install --upgrade mkdocs-material
|
pip install --upgrade --force-reinstall mkdocs-material
|
||||||
```
|
```
|
||||||
|
|
||||||
Show the currently installed version with:
|
Show the currently installed version with:
|
||||||
|
Loading…
Reference in New Issue
Block a user