Skip to content

Latest commit

 

History

History
92 lines (55 loc) · 2.47 KB

README.md

File metadata and controls

92 lines (55 loc) · 2.47 KB

license release GitHub release date GitHub Actions status

Docker image for mdBook

Alpine Base Docker Image for mdBook

Alpine base Docker Image for rust-lang/mdBook.

DockerHub Badge

ghcr.io/peaceiris/mdbook is also available.

Getting started

Image tag Base Image Image size Notes
peaceiris/mdbook:v0.x.x alpine:3.12 22.2MB Small image
peaceiris/mdbook:v0.x.x-rust rust:1.49-alpine3.12 508MB mdbook test subcommand is available

Docker Compose

Create your docker-compose.yml like the following.

version: '3'

services:
  mdbook:
    container_name: mdbook
    image: peaceiris/mdbook:v0.x.x
    # image: peaceiris/mdbook:v0.x.x-rust
    stdin_open: true
    tty: true
    ports:
      - 3000:3000
      - 3001:3001
    volumes:
      - ${PWD}:/book
    command:
      - serve
      - --hostname
      - '0.0.0.0'

Usage

# Run "mdbook serve"
docker-compose up

# Run a command of mdBook
docker-compose run --rm mdbook init

GitHub Actions for mdBook

The mdBook Setup GitHub Action is recommended.

License

About the author