About Material for MkDocs¶
Material for MkDocs is a documentation framework based on MkDocs.
It has a better looking interface than plain MkDocs and offers various features to help organize your documentation with Markdown.
How and why do we use Material for MkDocs¶
We use Material for MkDocs to generate the documentation website.
Install and run Material for MkDocs¶
Following the instructions in the documentation repository to install and run Material for MkDocs.
Configuration¶
The configuration for Material for MkDocs is located in the mkdocs.yml configuration file.
Common tasks¶
Add a new page¶
Add a new page by creating a new file/directory in the docs directory. All pages must have a .md file extension.
Add a new navigation entry¶
Add a new entry to the navigation in the mkdocs.yml file under the nav property.
Add a new glossary entry¶
Add a new entry to the glossary in the docs/glossary.md file.
The format must be as follow.
Each word that Material for MkDocs will find in the documentation will have a tooltip with the definition for the word.
Resources and alternatives¶
These resources and alternatives are related to the current item (in alphabetical order).