Conventions¶

This documentation use some symbols for illustration purposes. Before you read on, please make sure you've made yourself familiar with the following list of conventions:

Release Type¶

The tag symbol in conjunction with a version number denotes when a specific feature or behavior was added. Make sure you're at least on this version if you want to use it.: stable; beta

Controls¶

These icons define what type of control a specified setting uses.: toggle; textbox; dropdown; button; slider; color wheel

Default Value¶

This defines what the default value for a setting is.: Specified setting has a default value; Specified setting has no default value and is empty; Specified setting is automatically computed by the app

Command¶

This defines a command: Specified setting has a default value

Experimental¶

Anything listed with this icon are features or functionality that are still in development and may change in future versions.

Required value¶

Items listed with this symbol indicate that they are required to be set.

Customization¶

This symbol denotes that the item described is a customization which affects the overall look of the app.

3^rd Party¶

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

– Metadata property¶

This symbol denotes that the item described is a metadata property, which can be used in Markdown documents as part of the front matter definition.

– Multiple instances¶

This symbol denotes that the plugin supports multiple instances, i.e, that it can be used multiple times in the plugins setting in mkdocs.yml.

– Optional feature¶

Most of the features are hidden behind feature flags, which means they must be explicitly enabled via mkdocs.yml. This allows for the existence of potentially orthogonal features.

– Backers only¶

The pumping heart symbol denotes that a specific feature or behavior is only available to backers. Normal users will not have access to this particular item.