Merge branch 'master' into feature/insiders-ghost-pepper

This commit is contained in:
squidfunk 2021-11-13 15:32:59 +01:00
commit aa4de1bd3a
5 changed files with 28 additions and 22 deletions

View File

@ -16,6 +16,16 @@ If not, we recommended using [`docker`][docker].
## Installation ## Installation
!!! danger "8.0.0 Beta 1 is out!"
Help test the latest version of Material for MkDocs, introducing many new
features and improvements like [code annotations], [anchor tracking] and
[version warnings]. See #3219 for installation and upgrade instructions.
[code annotations]: reference/code-blocks.md#code-annotations
[anchor tracking]: setup/setting-up-navigation.md#anchor-tracking
[version warnings]: setup/setting-up-versioning.md#version-warning
### with pip <small>recommended</small> { #with-pip data-toc-label="with pip" } ### with pip <small>recommended</small> { #with-pip data-toc-label="with pip" }
Material for MkDocs can be installed with `pip`: Material for MkDocs can be installed with `pip`:

View File

@ -174,10 +174,7 @@ The following features are solely available via Material for MkDocs Insiders:
- [x] [Boosting pages in search] - [x] [Boosting pages in search]
- [x] [Tags] with search integration - [x] [Tags] with search integration
- [x] [Stay on page when switching versions] - [x] [Stay on page when switching versions]
- [x] [Version warning]
- [x] [Custom admonition icons] - [x] [Custom admonition icons]
- [x] [Code annotations]
- [x] [Anchor tracking]
- [x] [Mermaid.js integration] - [x] [Mermaid.js integration]
</div> </div>
@ -192,16 +189,6 @@ features prefixed with a checkmark symbol, denoting whether a feature is
:octicons-check-circle-fill-24:{ style="color: var(--md-default-fg-color--lightest)" } planned, but not yet implemented. When the funding goal is hit, the features :octicons-check-circle-fill-24:{ style="color: var(--md-default-fg-color--lightest)" } planned, but not yet implemented. When the funding goal is hit, the features
are released for general availability. are released for general availability.
#### $ 4,000 Ghost Pepper
- [x] [Anchor tracking]
- [x] [Code annotations]
- [x] [Version warning]
[Anchor tracking]: ../setup/setting-up-navigation.md#anchor-tracking
[Code annotations]: ../reference/code-blocks.md#adding-annotations
[Version warning]: ../setup/setting-up-versioning.md#version-warning
#### $ 5,000 Aji Panca #### $ 5,000 Aji Panca
- [x] [Mermaid.js integration] - [x] [Mermaid.js integration]
@ -259,6 +246,16 @@ This section lists all funding goals that were previously completed, which means
that those features were part of Insiders, but are now generally available and that those features were part of Insiders, but are now generally available and
can be used by all users. can be used by all users.
#### $ 4,000 Ghost Pepper
- [x] [Anchor tracking]
- [x] [Code annotations]
- [x] [Version warning]
[Anchor tracking]: ../setup/setting-up-navigation.md#anchor-tracking
[Code annotations]: ../reference/code-blocks.md#adding-annotations
[Version warning]: ../setup/setting-up-versioning.md#version-warning
#### $ 3,000 Caribbean Red #### $ 3,000 Caribbean Red
- [x] [Sticky navigation tabs] - [x] [Sticky navigation tabs]

View File

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

View File

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

View File

@ -62,8 +62,7 @@ Check out the versioning example to see it in action
### Version warning ### Version warning
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } · [:octicons-tag-24: 8.0.0b1][Version warning support] ·
[:octicons-tag-24: insiders-2.5.0][Insiders] ·
:octicons-file-symlink-file-24: Customization :octicons-file-symlink-file-24: Customization
If you're using versioning, you might want to display a warning when the user 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]. 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 [theme extension]: ../customization.md#extending-the-theme
[overriding blocks]: ../customization.md#overriding-blocks [overriding blocks]: ../customization.md#overriding-blocks
[Version warning preview]: ../assets/screenshots/version-warning.png [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/ docs.example.com/0.1/bar/ -> docs.example.com/0.2/
``` ```
[Insiders]: ../insiders/index.md
## Usage ## Usage
While this section outlines the basic workflow for publishing new versions, While this section outlines the basic workflow for publishing new versions,