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.: default; stable; development

Controls¶

These icons define what type of control a specified setting uses.: toggle; toggle on; toggle off; 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

– Flags¶

Default

Experimental

Required

Customization

Metadata

Dangerous

Multiple

Setting

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

– 3^rd Party¶

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

– Configurable Settings¶

The following denotes a configurable setting. These can also be broken up into individual settings as shown below:

`enabled`¶

1.0.0 true

This is an example setting

`other`¶

1.0.0 true

This is another example setting

– 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¶

Some features may be hidden behind feature flags, which means they must be explicitly enabled first before they can be configured. This allows for the existence of potentially orthogonal features.

– Markdown extension¶

This symbol denotes that the thing described is a Markdown element.

– Dangerous¶

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.

– 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.

Other Tags¶

Example Download¶

.zip

The following denotes a downloadable file.

Commands¶

-s, --start

The above denotes a command which can be executed in a terminal / command prompt.

Options¶

Options are another form of setting which lists what the option does, and then examples of how it works.

enabled

true This option specifies whether the plugin is enabled when building your project. If you want to speed up local builds, you can use an environment variable:

plugins:
  - rss:
      enabled: !ENV [CI, false]

match_path

.* This option specifies which pages should be included in the feed. For example, to only include blog posts in the feed, use the following regular expression:

plugins:
  - rss:
      match_path: blog/posts/.*