Getting started¶

Material for MkDocs is a theme for MkDocs, a static site generator geared towards (technical) project documentation. If you're familiar with Python, you can install Material for MkDocs with pip, the Python package manager. If not, we recommended using docker.

In case you're running into problems, consult the troubleshooting section.

Installation¶

with pip¶

Material for MkDocs can be installed with pip:

pip install mkdocs-material

pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git

This will automatically install compatible versions of all dependencies: MkDocs, Markdown, Pygments and Python Markdown Extensions. Material for MkDocs always strives to support the latest versions, so there's no need to install those packages separately.

Note that in order to install Insiders, you'll need to become a sponsor, create a personal access token¹, and set the GH_TOKEN environment variable to the token's value.

with docker¶

The official Docker image is a great way to get up and running in a few minutes, as it comes with all dependencies pre-installed. Pull the image for the latest version with:

docker pull squidfunk/mkdocs-material

docker login -u ${GH_USERNAME} -p ${GH_TOKEN} ghcr.io
docker pull ghcr.io/squidfunk/mkdocs-material-insiders

The mkdocs executable is provided as an entry point and serve is the default command. If you're not familiar with Docker don't worry, we have you covered in the following sections.

The following plugins are bundled with the Docker image:

• mkdocs-minify-plugin
• mkdocs-redirects

Note that in order to install Insiders, you'll need to become a sponsor, create a personal access token², and set the GH_TOKEN environment variable to the token's value.

FROM squidfunk/mkdocs-material
RUN pip install ...

docker build -t squidfunk/mkdocs-material .

with git¶

Material for MkDocs can be directly used from GitHub by cloning the repository into a subfolder of your project root which might be useful if you want to use the very latest version:

git clone https://github.com/squidfunk/mkdocs-material.git

git clone git@github.com:squidfunk/mkdocs-material-insiders.git mkdocs-material

The theme will reside in the folder mkdocs-material/material. When cloning from git, you must install all required dependencies yourself:

pip install -r mkdocs-material/requirements.txt

Note that in order to install Insiders, you'll need to become a sponsor.