Skip to content

Commit acd154d

Browse files
committed
Updated Insiders documentation
1 parent 07bc90e commit acd154d

File tree

3 files changed

+50
-4
lines changed

3 files changed

+50
-4
lines changed

docs/insiders/index.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,15 @@ a handful of them, [thanks to our awesome sponsors]!
8282
## What's in for me?
8383

8484
The moment you [become a sponsor][how to become a sponsor], you'll get __immediate
85-
access to 24 additional features__ that you can start using right away, and
85+
access to 25 additional features__ that you can start using right away, and
8686
which are currently exclusively available to sponsors:
8787

8888
<div class="mdx-columns" markdown>
8989

90+
- [x] [Navigation status] :material-alert-decagram:{ .mdx-pulse title="Added on August 21, 2022" }
9091
- [x] [Meta plugin] :material-alert-decagram:{ .mdx-pulse title="Added on July 17, 2022" }
9192
- [x] [Additional tags indexes] :material-alert-decagram:{ .mdx-pulse title="Added on July 7, 2022" }
92-
- [x] [Document contributors] :material-alert-decagram:{ .mdx-pulse title="Added on June 24, 2022" }
93+
- [x] [Document contributors]
9394
- [x] [Automatic light / dark mode]
9495
- [x] [Content tabs: anchor links]
9596
- [x] [Navigation pruning]
@@ -266,13 +267,14 @@ are released for general availability.
266267
- [x] [Chinese search support]
267268
- [x] [Navigation icons]
268269
- [x] [Navigation pruning]
269-
- [ ] Navigation status badges
270+
- [x] [Navigation status]
270271
- [ ] Blog plugin
271272

272273
[Annotations]: ../reference/annotations.md
273274
[Chinese search support]: ../blog/2022/chinese-search-support.md
274275
[Navigation icons]: ../reference/index.md#setting-the-page-icon
275276
[Navigation pruning]: ../setup/setting-up-navigation.md#navigation-pruning
277+
[Navigation status]: ../reference/index.md#setting-the-page-status
276278

277279
#### $ 14,000 – Goat's Horn
278280

docs/reference/index.md

+44
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,50 @@ icon: material/emoticon-happy # (1)!
123123
[Insiders]: ../insiders/index.md
124124
[icon search]: icons-emojis.md#search
125125

126+
### Setting the page status
127+
128+
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
129+
[:octicons-tag-24: insiders-4.22.0][Insiders] ·
130+
:octicons-beaker-24: Experimental
131+
132+
A status can be assigned to each page, which is then displayed as part of the
133+
navigation sidebar. First, associate a status identifier with a description by
134+
adding the following to `mkdocs.yml`:
135+
136+
``` yaml
137+
extra:
138+
status:
139+
<identifier>: <description> # (1)!
140+
```
141+
142+
1. The identifier can only include alphanumeric characters, as well as dashes
143+
and underscores. For example, if you have a status `Recently added`, you can
144+
set `new` as an identifier:
145+
146+
``` yaml
147+
extra:
148+
status:
149+
new: Recently added
150+
```
151+
152+
The page status can now be set for a document with the front matter `status`
153+
property. For example, you can mark a page as `new` with the following lines at
154+
the top of a Markdown file:
155+
156+
``` sh
157+
---
158+
status: new
159+
---
160+
161+
# Document title
162+
...
163+
```
164+
165+
The following status identifiers are currently supported:
166+
167+
- :material-alert-decagram: – `new`
168+
- :material-trash-can: – `deprecated`
169+
126170
### Setting the page template
127171

128172
If you're using [theme extension] and created a new page template in the

docs/setup/adding-a-git-repository.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ them at your own risk.
206206
[git-revision-date-localized]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
207207
[enable_creation_date support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.1.4
208208

209-
#### Document contributors :material-alert-decagram:{ .mdx-pulse title="Added on June 24, 2022" }
209+
#### Document contributors
210210

211211
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
212212
[:octicons-tag-24: insiders-4.19.0][Insiders] ·

0 commit comments

Comments
 (0)