-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
83 changed files
with
6,874 additions
and
3,351 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Conventions | ||
|
||
This section explains several conventions used in this documentation. | ||
|
||
## Symbols | ||
|
||
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: | ||
|
||
### <!-- md:sponsors --> – Sponsors only { data-toc-label="Sponsors only" } | ||
|
||
The pumping heart symbol denotes that a specific feature or behavior is only | ||
available to sponsors via [Insiders]. Make sure that you have access to | ||
[Insiders] if you want to use the feature. | ||
|
||
### <!-- md:version --> – Version { data-toc-label="Version" } | ||
|
||
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. | ||
|
||
### <!-- md:version insiders- --> – Version (Insiders) { data-toc-label="Version (Insiders)" } | ||
|
||
The tag symbol with a heart in conjunction with a version number denotes that a | ||
specific feature or behavior was added to the [Insiders] version of Material for | ||
MkDocs. | ||
|
||
### <!-- md:default --> – Default value { #default data-toc-label="Default value" } | ||
|
||
Some properties in `mkdocs.yml` have default values for when the author does not | ||
explicitly define them. The default value of the property is always included. | ||
|
||
#### <!-- md:default computed --> – Default value is computed { #default data-toc-label="is computed" } | ||
|
||
Some default values are not set to static values but computed form other values, | ||
like the site language, repository provider, or other settings. | ||
|
||
#### <!-- md:default none --> – Default value is empty { #default data-toc-label="is empty" } | ||
|
||
Some properties do not contain default values. This means that the functionality | ||
that is associated with them is not available unless explicitly enabled. | ||
|
||
### <!-- md:feature --> – Optional feature { #feature data-toc-label="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. | ||
|
||
### <!-- md:flag experimental --> – Experimental { data-toc-label="Experimental" } | ||
|
||
Some newer features are still considered experimental, which means the ymight | ||
(although rarely) change at any time, including their complete removal (which | ||
hasn't happened yet). | ||
|
||
### <!-- md:plugin --> – Plugin { data-toc-label="Plugin" } | ||
|
||
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. | ||
|
||
### <!-- md:utility --> – Utility { data-toc-label="Utility" } | ||
|
||
Besides plugins, there are some utilities that build on top of MkDocs in order | ||
to provide extended functionality, like for example support for versioning. | ||
|
||
[Insiders]: insiders/index.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.