From f9d5c6709b2692cf083e413c9d944dc9d59b4079 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Thu, 14 Sep 2023 19:54:33 +0200 Subject: [PATCH] Documentation --- docs/conventions.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/conventions.md b/docs/conventions.md index 12492f62a..6b341fcce 100644 --- a/docs/conventions.md +++ b/docs/conventions.md @@ -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 that is associated with them is not available unless explicitly enabled. +### – 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. + ### – Optional feature { #feature data-toc-label="Optional feature" } 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 installation is required. +### – 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. + +### – 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. + +### – Customization { #customization data-toc-label="Customization" } + +This symbol denotes that the thing described is a customization that must be +added by the author. + ### – Utility { data-toc-label="Utility" } Besides plugins, there are some utilities that build on top of MkDocs in order