Previewing as you write

In order to preview MkDocs as you write, you will first need to run MkDocs locally with Docker.

Warning

The Docker container is intended for local previewing purposes only and is not suitable for deployment. This is because the web server used by MkDocs for live previews is not designed for production use and may have security vulnerabilities.

Previewing as you write

MkDocs includes a live preview server, so you can preview your changes as you write your documentation. The server will automatically rebuild the site upon saving. Start MkDocs in Docker with:

Unix, PowershellWindows

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

docker run --rm -d -it -p 8000:8000 -v "%cd%":/docs squidfunk/mkdocs-material

Point your browser to localhost:8000 and you should see: