https://github.com/peaceiris/docker-mdbook

Alpine-based Docker Images for mdBook: CPU Architectures amd64 and arm64 are supported.
https://github.com/peaceiris/docker-mdbook

alpine docker mdbook rust

Last synced: 13 days ago
JSON representation

Alpine-based Docker Images for mdBook: CPU Architectures amd64 and arm64 are supported.

• Host: GitHub
• URL: https://github.com/peaceiris/docker-mdbook
• Owner: peaceiris
• License: mit
• Created: 2019-12-04T21:16:03.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-30T10:03:20.000Z (14 days ago)
• Last Synced: 2024-10-30T10:25:19.918Z (14 days ago)
• Topics: alpine, docker, mdbook, rust
• Language: CSS
• Homepage: https://hub.docker.com/r/peaceiris/mdbook
• Size: 1.05 MB
• Stars: 46
• Watchers: 2
• Forks: 14
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![license](https://img.shields.io/github/license/peaceiris/docker-mdbook.svg)](https://github.com/peaceiris/docker-mdbook/blob/main/LICENSE)



## Alpine-Based Docker Images for mdBook

Alpine-based Docker Images for [rust-lang/mdBook].

[rust-lang/mdBook]: https://github.com/rust-lang/mdBook

- [peaceiris/mdbook - Docker Hub]

[peaceiris/mdbook - Docker Hub]: https://hub.docker.com/r/peaceiris/mdbook

[![DockerHub Badge](https://dockeri.co/image/peaceiris/mdbook)][peaceiris/mdbook - Docker Hub]

Docker images on GitHub Packages [ghcr.io/peaceiris/mdbook] are also available.

[ghcr.io/peaceiris/mdbook]: https://github.com/users/peaceiris/packages/container/package/mdbook

CPU architectures amd64 and arm64 are supported.

## Pre-installed preprocessors for mdBook

- [mdbook-mermaid]

- [mdbook-toc]

- [mdbook-admonish]

[mdbook-mermaid]: https://github.com/badboy/mdbook-mermaid

[mdbook-toc]: https://github.com/badboy/mdbook-toc

[mdbook-admonish]: https://github.com/tommilligan/mdbook-admonish

## 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`](https://github.com/peaceiris/docker-mdbook/blob/main/example/compose.yml).

```sh

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.

- [peaceiris/actions-mdbook: GitHub Actions for mdBook (rust-lang/mdBook) ⚡️ Setup mdBook quickly and build your site fast. Linux (Ubuntu), macOS, and Windows are supported.](https://github.com/peaceiris/actions-mdbook)

## License

- [MIT License - peaceiris/docker-mdbook]

[MIT License - peaceiris/docker-mdbook]: https://github.com/peaceiris/docker-mdbook/blob/main/LICENSE

## About the author

- [peaceiris homepage](https://peaceiris.com/)