viruscoding / docker-mkdocs

MkDocs in a Docker. (Alpine)

MkDocs in a docker.

Felling like supporting me in my projects use donate button. Thank You!

Docker Image with MkDocs. It's using tiny image provided by Alpine.
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

Purpose of this image was to simplify the process of deploying MkDocs. This image is based on Alpine Linux to minimize the size of the image.

Workdir is set to /workdir

Environmental Variables

Variable	Notes
GIT_REPO	Remote git based repository - requires mounted keys see examples below
LIVE_RELOAD_SUPPORT	Support for live reload feature. Default set to false - Use if auto reload needed

Usage

docker run \
    -ti \
    --name mkdocs \
    polinux/mkdocs

Mount Volume into working directory and make it available on port 80 on localhost.

docker run \
    -ti \
    --name mkdocs \
    -p 80:8000 \
    -v /my_docs_dir:/workdir \
    polinux/mkdocs

Fetch from git repository with ssh keys shared from host os

docker run \
    -ti \
    --name mkdocs \
    -e GIT_REPO='[email protected]:username/my-repo.git' \
    -e LIVE_RELOAD_SUPPORT='true' \
    -v ~/.ssh:/root/.ssh:ro \
    polinux/mkdocs

-v ~/.ssh:/root/.ssh:ro - Mouts ssh keys from host OS and sets read-only permissions

Docker Compose file contains default settings for deploying in local directory and it's set to bind port 8000 to localhost.

Build

docker build -t polinux/mkdocs .

Docker troubleshooting

Use docker command to see if all required containers are up and running:

docker ps

Check logs of mkdocs server container:

docker logs mkdocs

Sometimes you might just want to review how things are deployed inside a running container, you can do this by executing a bash shell through docker's exec command:

docker exec -ti mkdocs /bin/bash

History of an image and size of layers:

docker history --no-trunc=true polinux/mkdocs | tr -s ' ' | tail -n+2 | awk -F " ago " '{print $2}'

Author

Przemyslaw Ozgo

License