Skip to content

Commit cdc879a

Browse files
committed
docs: update shortcodes.py
1 parent d3f7a6e commit cdc879a

File tree

6 files changed

+202
-41
lines changed

6 files changed

+202
-41
lines changed

docs/docs/about/backers.md

Whitespace-only changes.
File renamed without changes.

docs/docs/about/conventions.md

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,15 @@ This defines what the default value for a setting is.
3333

3434
: <!-- md:default --> Specified setting has a default value
3535
: <!-- md:default none --> Specified setting has no default value and is empty
36+
: <!-- md:default computed --> Specified setting is automatically computed by the app
37+
38+
<br />
39+
40+
## <!-- md:command --> Command { #command data-toc-label="Command" }
41+
42+
This defines a command
43+
44+
: <!-- md:command --> Specified setting has a default value
3645

3746
<br />
3847

@@ -50,12 +59,45 @@ Items listed with this symbol indicate that they are required to be set.
5059

5160
## <!-- md:flag customization --> Customization { #customization data-toc-label="Customization" }
5261

53-
This symbol denotes that the item described is a customization which affects the overall look of the plugin.
62+
This symbol denotes that the item described is a customization which affects the overall look of the app.
5463

5564
<br />
5665

57-
## <!-- md:utility --> Utility { data-toc-label="Utility" }
66+
## <!-- md:3rdparty --> 3rd Party { data-toc-label="3rd Party" }
5867

5968
This symbol denotes that the item described is classified as something that changes the overall functionality of the plugin.
6069

61-
[Insiders]: insiders/index.md
70+
<br />
71+
72+
### <!-- md:flag metadata --> – Metadata property { #metadata data-toc-label="Metadata property" }
73+
74+
This symbol denotes that the item described is a metadata property, which can
75+
be used in Markdown documents as part of the front matter definition.
76+
77+
<br />
78+
79+
### <!-- md:flag multiple --> – Multiple instances { #multiple-instances data-toc-label="Multiple instances" }
80+
81+
This symbol denotes that the plugin supports multiple instances, i.e, that it
82+
can be used multiple times in the `plugins` setting in `mkdocs.yml`.
83+
84+
<br />
85+
86+
### <!-- md:feature --> – Optional feature { #feature data-toc-label="Optional feature" }
87+
88+
Most of the features are hidden behind feature flags, which means they must
89+
be explicitly enabled via `mkdocs.yml`. This allows for the existence of
90+
potentially orthogonal features.
91+
92+
<br />
93+
94+
### <!-- md:backers --> – Backers only { data-toc-label="Backers only" }
95+
96+
The pumping heart symbol denotes that a specific feature or behavior is only
97+
available to backers. Normal users will not have access to this particular item.
98+
99+
<br />
100+
101+
---
102+
103+
<br />
Binary file not shown.

0 commit comments

Comments
 (0)