Skip to content

Installation

MaterialX is a powerful documentation framework:

  • Born for documents, yet beyond documents
  • Accessible to everyone, extremely easy to use
  • Modern, lightweight, customizable, responsive

You can install it in the following ways.

with pip

MaterialX is published as a Python package and can be installed with pip, ideally by using a virtual environment.

Open up a terminal and install MaterialX with:

pip install mkdocs-materialx

pip install mkdocs-materialx==10.1.3

pip install --upgrade mkdocs-materialx

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

with docker

official docker image

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. Open up a terminal and pull the image with:

docker pull jaywhj/mkdocs-materialx

docker pull jaywhj/mkdocs-materialx:10.1.4

add more plugins

Material for MkDocs only bundles selected plugins in order to keep the size of the official image small. If the plugin you want to use is not included, you can add them easily. Create a Dockerfile and extend the official image:

Dockerfile
FROM jaywhj/mkdocs-materialx
RUN pip install mkdocs-glightbox

build the image

docker build -t materialx .

run the container

docker run -p 8000:8000 -v ${PWD}:/docs materialx

with git

You can also clone the source code from a GitHub repo via git clone and install it locally:

git clone https://github.com/jaywhj/mkdocs-materialx.git

Next, install it with the following command:

pip install -e mkdocs-materialx