joshbeard/docker-mkdocs-material

Docker image containing MkDocs + Squidfunk Material theme

mkdocs-material

An image containing mkdocs with the material theme and plugins.

This image is built from the python 3.x-slim and 3.x-alpine images.

Project Resources

• Source Repository: https://github.com/joshbeard/docker-mkdocs-material
• Dockerfile: (Alpine; default)
• Dockerfile-slim: (Debian)
• Docker Hub: https://hub.docker.com/r/joshbeard/mkdocs-material

Tags

• 9, 9-alpine: Current 9.x release from PyPi from the python:3.x-alpine Alpine image.
• 9-slim: Current 9.x release from PyPi from the python:3.x-slim Debian image.
• latest, latest-alpine: Current release from PyPi from the python:3.x-alpine Alpine image.
• latest-slim: Current release from PyPi from the python:3.x-slim Debian image.

Running

Mount a folder with an mkdocs site and mkdocs.yml file to /docs on the container.

• Start the development server on :8000

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs joshbeard/mkdocs-material:9

• Build documentation. This produces static content in a site/ directory:

docker run --rm -it -v ${PWD}:/docs joshbeard/mkdocs-material:9 build

Refer to the example to see an example site using docker-compose.

Plugins

• Check builds/latest-requirements.txt
• The example site MkDocs config has several plugins enabled.
• https://pypi.org/project/pymdown-env/

Maintainers

• Josh Beard, https://joshbeard.me