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

Docker image containing MkDocs + Squidfunk Material theme
https://github.com/joshbeard/docker-mkdocs-material

docker docker-image dockerfile mkdocs mkdocs-material

Last synced: 1 day ago
JSON representation

Docker image containing MkDocs + Squidfunk Material theme

• Host: GitHub
• URL: https://github.com/joshbeard/docker-mkdocs-material
• Owner: joshbeard
• License: 0bsd
• Created: 2022-02-07T18:17:24.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-12-25T22:18:45.000Z (about 1 month ago)
• Last Synced: 2025-01-19T20:08:19.174Z (7 days ago)
• Topics: docker, docker-image, dockerfile, mkdocs, mkdocs-material
• Language: Dockerfile
• Homepage: https://hub.docker.com/r/joshbeard/mkdocs-material
• Size: 205 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mkdocs-material

[![CodeFactor](https://www.codefactor.io/repository/github/joshbeard/docker-mkdocs-material/badge)](https://www.codefactor.io/repository/github/joshbeard/docker-mkdocs-material)

An image containing [mkdocs](https://www.mkdocs.org/) with the

[material](https://squidfunk.github.io/mkdocs-material/) theme and plugins.

This image is built from the [python](https://hub.docker.com/_/python)

_3.x-slim_ and _3.x-alpine_ images.

## Project Resources

* Source Repository: 

* [`Dockerfile`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile): (Alpine; default)

* [`Dockerfile-slim`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile): (Debian)

* Docker Hub: 

## Tags

* [`9`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile),

  [`9-alpine`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile):

  Current 9.x release from PyPi from the `python:3.x-alpine` Alpine image.

* [`9-slim`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile-slim):

  Current 9.x release from PyPi from the `python:3.x-slim` Debian image.

* [`latest`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile),

  [`latest-alpine`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile):

  Current release from PyPi from the `python:3.x-alpine` Alpine image.

* [`latest-slim`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile-slim):

  Current release from PyPi from the `python:3.x-slim` Debian image.

## Running

Mount a folder with an mkdocs site and `mkdocs.yml` file to `/docs` on the container.

* Start the development server on `:8000`

```shell

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

```

* Build documentation. This produces static content in a `site/` directory:

```shell

docker run --rm -it -v ${PWD}:/docs joshbeard/mkdocs-material:9 build

```

Refer to the [example](https://github.com/joshbeard/docker-mkdocs-material/tree/master/example) to see an example

site using `docker-compose`.

## Plugins

* Check [`builds/latest-requirements.txt`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/builds/latest-requirements.txt)

* The [example site MkDocs config](https://github.com/joshbeard/docker-mkdocs-material/tree/master/example/mkdocs.yml) has several plugins enabled.

* 

## Maintainers

* Josh Beard,