/docker-mkdocs

MkDocs image https://github.com/mkdocs/mkdocs/

Primary LanguageDockerfile

docker-mkdocs

Python 3.6 on Alpine

Docker Hub

MkDocs simple static website generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

Description

Theme flatly of Bootswatch is used as website theme by default in image. You can change to your prefer theme in list of Bootswatch easily by modify the theme: in mkdocs.yml, ex: theme: amelia to use amelia theme.

Run container:

docker run -d -p 8000:8000 pengbai/docker-mkdocs

Project config file (mkdocs.yml, theme, docs) is under path /workspace in image. Use your own documentation to generat your website:

docker run -d -p 8000:8000 -v /local-workspace:/workspace pengbai/docker-mkdocs