OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2023-09-14 19:54:33 +02:00
parent efdb49e873
commit f9d5c6709b
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/conventions.md
View File

@ -41,6 +41,11 @@ like the site language, repository provider, or other settings.
Some properties do not contain default values. This means that the functionality Some properties do not contain default values. This means that the functionality
that is associated with them is not available unless explicitly enabled. that is associated with them is not available unless explicitly enabled.
### <!-- md:flag metadata --> – Metadata property { #metadata data-toc-label="Metadata property" }
This symbol denotes that the thing described is a metadata property, which can
be used in Markdown documents as part of the front matter definition.
### <!-- md:feature --> – Optional feature { #feature data-toc-label="Optional feature" } ### <!-- md:feature --> – Optional feature { #feature data-toc-label="Optional feature" }
Most of the features are hidden behind feature flags, which means they must 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,
some of which are built-in and distributed with Material for MkDocs, so no some of which are built-in and distributed with Material for MkDocs, so no
installation is required. installation is required.
### <!-- md:extension --> – Markdown extension { data-toc-label="Markdown extension" }
This symbol denotes that the thing described is a Markdown extension, which can
be enabled in `mkdocs.yml` and adds additional functionality to the Markdown
parser.
### <!-- md:flag required --> – Required value { #required data-toc-label="Required value" }
Some (very few in fact) properties or settings are required, which means the
authors must explicitly define them.
### <!-- md:flag customization --> – Customization { #customization data-toc-label="Customization" }
This symbol denotes that the thing described is a customization that must be
added by the author.
### <!-- md:utility --> – Utility { data-toc-label="Utility" } ### <!-- md:utility --> – Utility { data-toc-label="Utility" }
Besides plugins, there are some utilities that build on top of MkDocs in order Besides plugins, there are some utilities that build on top of MkDocs in order