1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-24 07:30:12 +01:00

Documentation

This commit is contained in:
squidfunk 2021-11-13 14:45:44 +01:00
parent db09bd0cf0
commit 6e0e799753
3 changed files with 8 additions and 9 deletions

View File

@ -43,8 +43,7 @@ See additional configuration options:
### Code annotations
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
[:octicons-tag-24: insiders-2.2.0][Insiders] ·
[:octicons-tag-24: 8.0.0b1][Code annotations support] ·
:octicons-unlock-24: Feature flag ·
:octicons-beaker-24: Experimental
@ -78,7 +77,7 @@ theme:
Note that the language shortcode which has to come first must now also be
prefixed by a `.`.
[Insiders]: ../insiders/index.md
[Code annotations support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0b1
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists
## Usage

View File

@ -41,8 +41,7 @@ especially useful for large documentation sites.
### Anchor tracking
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
[:octicons-tag-24: insiders-2.1.0][Insiders] ·
[:octicons-tag-24: 8.0.0b1][Anchor tracking support] ·
:octicons-unlock-24: Feature flag ·
:octicons-beaker-24: Experimental
@ -56,7 +55,7 @@ theme:
- navigation.tracking
```
[Insiders]: ../insiders/index.md
[Anchor tracking support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0b1
### Navigation tabs

View File

@ -62,8 +62,7 @@ Check out the versioning example to see it in action
### Version warning
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
[:octicons-tag-24: insiders-2.5.0][Insiders] ·
[:octicons-tag-24: 8.0.0b1][Version warning support] ·
:octicons-file-symlink-file-24: Customization
If you're using versioning, you might want to display a warning when the user
@ -103,7 +102,7 @@ extra:
Make sure that this matches the [default version].
[Insiders]: ../insiders/index.md
[Version warning support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0b1
[theme extension]: ../customization.md#extending-the-theme
[overriding blocks]: ../customization.md#overriding-blocks
[Version warning preview]: ../assets/screenshots/version-warning.png
@ -134,6 +133,8 @@ the current page:
docs.example.com/0.1/bar/ -> docs.example.com/0.2/
```
[Insiders]: ../insiders/index.md
## Usage
While this section outlines the basic workflow for publishing new versions,