Docker

Use this image to create a mkdocs site with the mkdocs-simple-plugin

Using the docker image, you don't need to have the plugin or its dependencies installed on your system to build, test, and deploy a mkdocs generated site.

Run in a docker container

Install, build and serve your docs:

docker run --rm -it --network=host -v ${PWD}:/docs --user $(id -u):$(id -g) althack/mkdocs-simple-plugin

Explanation of docker command-line options

command	description
-p 8000:8000	[required] Map the mkdocs server port to a port on your localhost.
-v ${PWD}:/docs	[required] Mount the local directory into the docs directory to build site.
--user $(id -u):$(id -g)	[recommended] Run the docker container with the current user and group.
--rm	[optional] remove the docker image after it finishes running.
-it	[optional] run in an interactive terminal.

The docker image runs mkdocs serve by default.

Set up a command-line alias

Add an alias for the docker command to serve docs from any workspace.

echo 'function mkdocs_simple() { 
    local port=${1:-"8000"}
    docker run --rm -p ${port}:8000 -v ${PWD}:/docs --user $(id -u):$(id -g) althack/mkdocs-simple-plugin
}' >> ~/.bashrc