How to use Material for MkDocs¶

Installation¶

Install Material for MkDocs with the following commands.

Linux macOS Windows

In a terminal, execute the following command(s).
1	`TODO`

In a terminal, execute the following command(s).
# Install Material for MkDocs and all its extensions
pip3 install \
	cairosvg \
	mkdocs-git-revision-date-localized-plugin \
	mkdocs-glightbox \
	mkdocs-material \
	mkdocs-minify-plugin \
	pillow

# Install Material for MkDocs dependencies
brew install \
	cairo \
	freetype \
	libffi \
	libjpeg \
	libpng \
	zlib

In a terminal, execute the following command(s).
1	`TODO`

Configuration¶

The configuration for Material for MkDocs is located in the mkdocs.yml configuration file.

Common tasks¶

Start the website for development¶

In a terminal, execute the following command(s).
1 2	`# Run at the root level of the repository mkdocs serve`

Build the website for production¶

In a terminal, execute the following command(s).
# Run at the root level of the repository
mkdocs build --site-dir public

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

1	`*[Abbr]: The full definition of the abbreviation`

Each word that Material for MkDocs will find in the documentation will have a tooltip with the definition for the word.

These explanations are related to the current item (in alphabetical order).

Resources and alternatives¶

These resources and alternatives are related to the current item (in alphabetical order).