Anything listed with this icon are features or functionality that are still in development and may change in future versions.
Items listed with this symbol indicate that they are required to be set.
-This symbol denotes that the item described is a customization which affects the overall look of the app.
-This symbol denotes that the item described is classified as something that changes the overall functionality of the plugin.
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.
-This symbol denotes that an item is configurable by the user
+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
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.
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.
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.
+This symbol denotes that the thing described is a Markdown element.
+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.
The pumping heart symbol denotes that a specific feature or behavior is only @@ -930,6 +1345,46 @@ available to backers. Normal users will not have access to this particular item.
.zip
+
The following denotes a downloadable file.
+The above denotes a command which can be executed in a terminal / command prompt.
+Options are another form of setting which lists what the option does, and then examples of how it works.
+enabledtrue 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][mkdocs.env]:
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:
+