MkDocs Docker

Documentation that simply works

Demo

Demo

Docker

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

http://localhost:8000/

Build documentation

docker run --rm -it -v $PWD:/docs squidfunk/mkdocs-material build

Deploy documentation to GitHub Pages

docker run --rm -it -v ~/.ssh:/root/.ssh -v $PWD:/docs squidfunk/mkdocs-material gh-deploy

Screenshots

More than just a static site

https://squidfunk.github.io/mkdocs-material/overrides/assets/images/spotlight/built-in-search.png

https://squidfunk.github.io/mkdocs-material/overrides/assets/images/spotlight/code-annotations.png

https://squidfunk.github.io/mkdocs-material/overrides/assets/images/spotlight/icons-emojis.png