diff --git a/docs/insiders/index.md b/docs/insiders/index.md index 0406a18e6..8c40a98b6 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -82,14 +82,15 @@ a handful of them, [thanks to our awesome sponsors]! ## What's in for me? The moment you [become a sponsor][how to become a sponsor], you'll get __immediate -access to 24 additional features__ that you can start using right away, and +access to 25 additional features__ that you can start using right away, and which are currently exclusively available to sponsors:
+- [x] [Navigation status] :material-alert-decagram:{ .mdx-pulse title="Added on August 21, 2022" } - [x] [Meta plugin] :material-alert-decagram:{ .mdx-pulse title="Added on July 17, 2022" } - [x] [Additional tags indexes] :material-alert-decagram:{ .mdx-pulse title="Added on July 7, 2022" } -- [x] [Document contributors] :material-alert-decagram:{ .mdx-pulse title="Added on June 24, 2022" } +- [x] [Document contributors] - [x] [Automatic light / dark mode] - [x] [Content tabs: anchor links] - [x] [Navigation pruning] @@ -266,13 +267,14 @@ are released for general availability. - [x] [Chinese search support] - [x] [Navigation icons] - [x] [Navigation pruning] -- [ ] Navigation status badges +- [x] [Navigation status] - [ ] Blog plugin [Annotations]: ../reference/annotations.md [Chinese search support]: ../blog/2022/chinese-search-support.md [Navigation icons]: ../reference/index.md#setting-the-page-icon [Navigation pruning]: ../setup/setting-up-navigation.md#navigation-pruning + [Navigation status]: ../reference/index.md#setting-the-page-status #### $ 14,000 – Goat's Horn diff --git a/docs/reference/index.md b/docs/reference/index.md index dca050360..032ef47b1 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -123,6 +123,50 @@ icon: material/emoticon-happy # (1)! [Insiders]: ../insiders/index.md [icon search]: icons-emojis.md#search +### Setting the page status + +[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · +[:octicons-tag-24: insiders-4.22.0][Insiders] · +:octicons-beaker-24: Experimental + +A status can be assigned to each page, which is then displayed as part of the +navigation sidebar. First, associate a status identifier with a description by +adding the following to `mkdocs.yml`: + +``` yaml +extra: + status: + : # (1)! +``` + +1. The identifier can only include alphanumeric characters, as well as dashes + and underscores. For example, if you have a status `Recently added`, you can + set `new` as an identifier: + + ``` yaml + extra: + status: + new: Recently added + ``` + +The page status can now be set for a document with the front matter `status` +property. For example, you can mark a page as `new` with the following lines at +the top of a Markdown file: + +``` sh +--- +status: new +--- + +# Document title +... +``` + +The following status identifiers are currently supported: + +- :material-alert-decagram: – `new` +- :material-trash-can: – `deprecated` + ### Setting the page template If you're using [theme extension] and created a new page template in the diff --git a/docs/setup/adding-a-git-repository.md b/docs/setup/adding-a-git-repository.md index 2742fa3b7..6da55fd13 100644 --- a/docs/setup/adding-a-git-repository.md +++ b/docs/setup/adding-a-git-repository.md @@ -206,7 +206,7 @@ them at your own risk. [git-revision-date-localized]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin [enable_creation_date support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.1.4 -#### Document contributors :material-alert-decagram:{ .mdx-pulse title="Added on June 24, 2022" } +#### Document contributors [:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } · [:octicons-tag-24: insiders-4.19.0][Insiders] ·