homecentr/mkdocs-material repository overview

⁠HomeCentr - mkdocs material

This docker image is an enriched version of the original squidfunk's mkdocs-material⁠ and adds drawio-exporter⁠ on top of that. The set up of the drawio-exporter⁠ and it's dependencies is not completely straightforward so I thought it could be also useful to others :wink:

⁠Usage

Update your mkdocs.yml file according to the guide in drawio-exporter⁠. Note that the container is running as root by default which means you have to add the --no-sandbox argument as shown below.

plugins:
  - drawio-exporter:
      drawio_args:
        - --no-sandbox

⁠Powershell

docker run --rm -it -p 8000:8000 -v ${$PWD}:/docs homecentr/mkdocs

⁠Bash

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs homecentr/mkdocs

⁠Exposed ports

⁠Volumes

⁠Security

The container is regularly scanned for vulnerabilities and updated. Further info can be found in the Security tab⁠.

⁠Container user

The container is tested to be running as a root. Given that it is a development container which should not be deployed anywhere and only used at build time this is an accepted feature.