MkDocs-DIY¶

A Docker file to build images for AMD & ARM devices with a installation of MkDocs that 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. Documentation for this container is written using itself.

Warning

Be aware! You should read carefully the usage documentation of every tool!

Thanks to¶

MkDocs
Material for MkDocs
All the extensions and packages that made this possible.

Details¶

Website	GitHub	Docker Hub
Deft.Work my personal blog	mkdocs-diy	mkdocs-diy

Docker Pulls	Docker Stars	Size	Sponsors

Docker Image Build Instructions¶

Build for amd64 or armv7l architecture (thanks to its Multi-Arch base image)

docker build -t elswork/mkdocs-diy .

Usage¶

The most interesting commands of MkDocs are serve and build, depending on your development environment you can use Make (Makefile) commands that are easier to remember, otherwise you must use docker standard commands.

Serve Page¶

Start the live-reloading docs server to preview site while perform changes.

make serve

Or

docker run -it --rm -v $(CURDIR):/mkdocs -p 7777:7777 elswork/mkdocs-diy mkdocs serve -a 0.0.0.0:7777

Point your browser to http://host-ip:7777 to preview site.

MkBuild Generate Page¶

It generates all the website static files inside /docs subfolder.

make mkbuild

Or

docker run -it --rm -v $(CURDIR):/mkdocs -p 7777:7777 elswork/mkdocs-diy mkdocs build

Use of mermaid diagrams¶

This image is also configured to use Mermaid Diagrams that allow the generation of diagrams and flowcharts from text in a similar manner as markdown. You can use its official Live editor to develop your diagrams (Flowchart, Sequence diagram, Gantt diagram, Class diagram, Git graph)

Example:

``` mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

Result:

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

Sponsor me! Together we will be unstoppable.

Other ways to fund me: