Code Monkey home page Code Monkey logo

docker-mdbook's Introduction

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

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

Getting started

Image tag Base Image Image size Notes
peaceiris/mdbook:v0.x.x alpine:3.16 24MB Minimum image
peaceiris/mdbook:v0.x.x-rust rust:1.65-alpine3.16 880MB mdbook test subcommand is available
ghcr.io/peaceiris/mdbook:v0.x.x alpine:3.16 24MB GitHub Packages: Minimum image
ghcr.io/peaceiris/mdbook:v0.x.x-rust rust:1.65-alpine3.16 880MB GitHub Packages: 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            # Minimum image
    # image: peaceiris/mdbook:v0.x.x-rust     # `mdbook test` subcommand is available
    # image: ghcr.io/peaceiris/mdbook:v0.x.x  # Docker images on GitHub Packages
    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

docker-mdbook's People

Contributors

dependabot[bot] avatar peaceiris avatar renovate[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.