https://github.com/nicksantamaria/docker-mkdocs
Container for running mkdocs - www.mkdocs.org
https://github.com/nicksantamaria/docker-mkdocs
docker-image mkdocs
Last synced: 21 days ago
JSON representation
Container for running mkdocs - www.mkdocs.org
- Host: GitHub
- URL: https://github.com/nicksantamaria/docker-mkdocs
- Owner: nicksantamaria
- Created: 2017-12-04T06:09:46.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-12-04T13:10:14.000Z (over 7 years ago)
- Last Synced: 2025-03-26T06:11:25.265Z (about 1 month ago)
- Topics: docker-image, mkdocs
- Homepage: https://hub.docker.com/r/nicksantamaria/mkdocs
- Size: 10.7 KB
- Stars: 0
- Watchers: 0
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mkdocs
Docker container for running `mkdocs` documentation static site generator.
## Usage
Run `mkdocs serve` command in background. Should allow you to view the site on http://localhost:8000
```bash
docker run --rm -v $(pwd):/data -p 8000:8000 -d nicksantamaria/mkdocs serve -a 0.0.0.0:8000
```
Run `mkdocs build` command.
```bash
docker run --rm -v $(pwd):/data nicksantamaria/mkdocs build
```
## Tags
There is a build for both Alpine Linux and Debian Jessie. Images are built weekly (Sunday night UTC), you have these choices for tags.
- `latest` - most recent Alpine image.
- `alpine` - most recent Alpine image.
- `jessie` - most recent Debian Jessie image.
- `[mkdocs-version]-alpine` - Specific version of mkdocs on Alpine.
- `[mkdocs-version]-jessie` - Specific version of mkdocs on Debian Jessie.
Only the latest version of `mkdocs` is built each week, pinning to an older version stop upstream security patches.
## Themes
For convenience, the following themes are bundled in the container:
* [Cinder](https://github.com/chrissimpkins/cinder)
* [Material](https://github.com/squidfunk/mkdocs-material)
* [Alabaster](https://github.com/iamale/mkdocs-alabaster)
* [Psinder](https://github.com/michaeltlombardi/mkdocs-psinder)
* [Bootswatch](https://github.com/mkdocs/mkdocs-bootswatch)
* [Bootstrap](https://github.com/mkdocs/mkdocs-bootstrap)
* [Windmill](https://github.com/gristlabs/mkdocs-windmill)
* [Windmill Dark](https://github.com/noraj1337/mkdocs-windmill-dark)