Skip to content

Commit f9d5c67

Browse files
committed
Documentation
1 parent efdb49e commit f9d5c67

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/conventions.md

+21
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ like the site language, repository provider, or other settings.
4141
Some properties do not contain default values. This means that the functionality
4242
that is associated with them is not available unless explicitly enabled.
4343

44+
### <!-- md:flag metadata --> – Metadata property { #metadata data-toc-label="Metadata property" }
45+
46+
This symbol denotes that the thing described is a metadata property, which can
47+
be used in Markdown documents as part of the front matter definition.
48+
4449
### <!-- md:feature --> – Optional feature { #feature data-toc-label="Optional feature" }
4550

4651
Most of the features are hidden behind feature flags, which means they must
@@ -59,6 +64,22 @@ Several features are implemented through MkDocs excellent plugin architecture,
5964
some of which are built-in and distributed with Material for MkDocs, so no
6065
installation is required.
6166

67+
### <!-- md:extension --> – Markdown extension { data-toc-label="Markdown extension" }
68+
69+
This symbol denotes that the thing described is a Markdown extension, which can
70+
be enabled in `mkdocs.yml` and adds additional functionality to the Markdown
71+
parser.
72+
73+
### <!-- md:flag required --> – Required value { #required data-toc-label="Required value" }
74+
75+
Some (very few in fact) properties or settings are required, which means the
76+
authors must explicitly define them.
77+
78+
### <!-- md:flag customization --> – Customization { #customization data-toc-label="Customization" }
79+
80+
This symbol denotes that the thing described is a customization that must be
81+
added by the author.
82+
6283
### <!-- md:utility --> – Utility { data-toc-label="Utility" }
6384

6485
Besides plugins, there are some utilities that build on top of MkDocs in order

0 commit comments

Comments
 (0)