https://github.com/homecentr/docker-mkdocs-material

https://github.com/homecentr/docker-mkdocs-material

docker-image drawio homecentr mkdocs mkdocs-material

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/homecentr/docker-mkdocs-material
• Owner: homecentr
• License: mit
• Archived: true
• Created: 2020-04-22T11:33:33.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-20T00:00:56.000Z (almost 2 years ago)
• Last Synced: 2024-07-29T19:15:01.480Z (3 months ago)
• Topics: docker-image, drawio, homecentr, mkdocs, mkdocs-material
• Language: Java
• Homepage: https://homecentr.github.io
• Size: 102 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![Project status](https://badgen.net/badge/project%20status/stable%20%26%20actively%20maintaned?color=green)](https://github.com/homecentr/docker-mkdocs-material/graphs/commit-activity) [![](https://badgen.net/github/label-issues/homecentr/docker-mkdocs-material/bug?label=open%20bugs&color=green)](https://github.com/homecentr/docker-mkdocs-material/labels/bug) [![](https://badgen.net/github/release/homecentr/docker-mkdocs-material)](https://hub.docker.com/repository/docker/homecentr/mkdocs-material)

[![](https://badgen.net/docker/pulls/homecentr/mkdocs-material)](https://hub.docker.com/repository/docker/homecentr/mkdocs-material) 

[![](https://badgen.net/docker/size/homecentr/mkdocs-material)](https://hub.docker.com/repository/docker/homecentr/mkdocs-material)

![CI/CD on master](https://github.com/homecentr/docker-mkdocs-material/workflows/CI/CD%20on%20master/badge.svg)

![Regular Docker image vulnerability scan](https://github.com/homecentr/docker-mkdocs-material/workflows/Regular%20Docker%20image%20vulnerability%20scan/badge.svg)

# HomeCentr - mkdocs material

This docker image is an enriched version of the original [squidfunk's mkdocs-material](https://github.com/squidfunk/mkdocs-material) and adds [drawio-exporter](https://github.com/LukeCarrier/mkdocs-drawio-exporter) on top of that. The set up of the [drawio-exporter](https://github.com/LukeCarrier/mkdocs-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](https://github.com/LukeCarrier/mkdocs-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.

```yml

plugins:

  - drawio-exporter:

      drawio_args:

        - --no-sandbox

```

### Powershell

```Powershell

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

```

### Bash

```Bash

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

```

## Exposed ports

| Port | Protocol | Description |

|------|------|-------------|

| 8000 | TCP | MkDocs development server |

## Volumes

| Container path| Description |

|------|-------------|

| /docs | Default working directory, this should be the directory with the mkdocs.yml file |

## Security 

The container is regularly scanned for vulnerabilities and updated. Further info can be found in the [Security tab](https://github.com/homecentr/docker-mkdocs/security).

### 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.