Skip to content

MkDocs

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.

Release Notes

This is the first proof of concept release that I created just to get a feel of the usage and process of the mkdocs container.

Build

1
2
3
git clone git@git.kernelfortress.org:docker/mkdocs
cd mkdocs
docker build -t mkdocs:test

Run

1
2
3
4
5
6
7
docker run -itd \
    --name mkdocs \
    --restart unless-stopped \
    -e REPO_URL=https://git.kernelfortress.org/fake/repo.git \
    -p ${YOUR_PORT}:8000 \
    -v /path/to/mkdocs/files:/data \
    registry.kernelfortress.org/docker/mkdocs