Build documentation files inside your code into a MkDocs site.
1.8K
Use this image to create a mkdocs site with the mkdocs-simple-plugin
By using the docker image, you don't need to have the plugin or its dependencies installed on your system in order to build, test, and deploy a mkdocs generated site.
Install, build and serve your docs:
docker run --rm -it --network=host -v ${PWD}:/docs --user $(id -u):$(id -g) athackst/mkdocs-simple-plugin
Explanation of docker command line options
| command | description |
|---|---|
--rm | [optional] remove the docker image after it finishes running. |
-it | [optional] run in an interactive terminal. |
-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. |
The docker image by default runs mkdocs serve.
TIP
Add an alias for the docker command to serve docs from any workspace.
echo 'function mkdocs_simple() {
docker run --rm -it --network=host -v ${PWD}:/docs --user $(id -u):$(id -g) athackst/mkdocs-simple-plugin $@
}' >> ~/.bashrc
See mkdocs-simple-plugin for more details
This software is licensed under Apache 2.0
Content type
Image
Digest
Size
97.8 MB
Last updated
over 5 years ago
docker pull athackst/mkdocs-simple-plugin