Awesome
<!-- https://shields.io/ -->
Alpine-Based Docker Images for mdBook
Alpine-based Docker Images for rust-lang/mdBook.
Docker images on GitHub Packages ghcr.io/peaceiris/mdbook are also available.
CPU architectures amd64 and arm64 are supported.
Pre-installed preprocessors for mdBook
Getting started
Available Docker Image Tags
| Image tag (mdBook version) | Base Image | Image size | Notes |
|---|---|---|---|
peaceiris/mdbook:v0.x.x | alpine:3.20 | 30MB | Minimum image |
peaceiris/mdbook:v0.x.x-rust | rust:1.78-alpine3.20 | 855MB | mdbook test subcommand is available |
ghcr.io/peaceiris/mdbook:v0.x.x | alpine:3.20 | 30MB | GitHub Packages: Minimum image |
ghcr.io/peaceiris/mdbook:v0.x.x-rust | rust:1.78-alpine3.20 | 855MB | GitHub Packages: mdbook test subcommand is available |
Docker Compose
Please refer to the example project and the compose.yml.
cd ./example
# Run "mdbook serve"
docker compose up
# Run "mdbook build"
docker compose run --rm mdbook build
# Run "mdbook init"
docker compose run --rm mdbook init
GitHub Actions for mdBook
The mdBook Setup GitHub Action is recommended.