Xavier2p / docker-mdbook-arm

mdBook Alpine Base Docker Image for ARM

mdbook Docker Image for ARM

Forked from peaceiris/docker-mdbook.

Alpine base Docker Image for rust-lang/mdBook.

Usage

Command	Description	Implemented
build	Build a book from its markdown files	✅
clean	Remove the book's build directory	✅
init	Create a new book with basic boilerplate	✅
linkcheck	Check for broken links in the rendered book	✅
serve	Start a web server for the book at http://localhost:3000	✅
test	Test the book's Rust code samples	❌
watch	Watch the book's markdown files and rebuild the book	✅

Docker Compose

Create your docker-compose.yml like the following, or just use the one in this repository.

version: '3'

services:
  mdbook:
    container_name: mdbook
    image: ghcr.io/xavier2p/mdbook:latest
    stdin_open: true
    tty: true
    ports:
      - 3000:3000
    volumes:
      - ${PWD}:/book
    command:
      - serve
      - --hostname
      - '0.0.0.0'

And run it with one of these commands:

# Run "mdbook serve"
docker-compose up

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

Docker CLI

# Run "mdbook serve"
docker run --rm -it -p 3000:3000 -v ${PWD}:/book ghcr.io/xavier2p/mdbook:latest serve --hostname '0.0.0.0'

# Run a command of mdBook
docker run --rm -it -v ${PWD}:/book ghcr.io/xavier2p/mdbook:latest <command>

GitHub Actions for mdBook

The mdBook Setup GitHub Action is recommended. You can find it here: peaceiris/actions-mdbook.

License

MIT License

Copyright (c) 2020 peaceiris (Shohei Ueda)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.