mkdocs (docker image)

Mkdocs including PythonMarkdown PlantUML extension.

This image will provide you mkdocs. Some examples of its usage:

Create a new project

docker run -it --rm -v `pwd`:/data scheja/mkdocs new my-project

Serve your project

If you are inside a VM (boot2docker or similar) you will need to set the host to 0.0.0.0:

cd my-project
docker run --rm -v `pwd`:/data -p 8000:8000 scheja/mkdocs serve -a 0.0.0.0:8000

or just

docker run --rm -v `pwd`:/data -p 8000:8000 scheja/mkdocs

Compile your docs to HTML

cd my-project
docker run -it --rm -v `pwd`:/data scheja/mkdocs build

If you want to generate them in another place, mount /data/site as a volume:

docker run -it --rm -v `pwd`:/data -v $HOME/Desktop/site:/data/site scheja/mkdocs build

PlantUML Usage

Inside your project file

site_name: My Site Name
markdown_extensions:
    - plantuml_markdown:
        server: ''

See the following site for uml usage: https://github.com/mikitex70/plantuml-markdown