Skip to content

Welcome to MkDocs

For full documentation visit mkdocs.org.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Setup

[!WARNING] Stable version of Material for MkDocs is 9.5, while the latest version has bugs which is not support livereload.

Using Python

python3 -m venv .venv
source .venv/bin/activate  # On Windows use `.venv\Scripts\activate.bat`
pip install mkdocs-material==9.5

Serving locally:

mkdocs serve

Using Docker

docker pull squidfunk/mkdocs-material:9.5

Serving locally:

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