mdBook Docker Image

Docker Image with mdBook + plugins. Meant for internal projects.

Table of Contents

1. Getting Started
2. Development
3. Dependencies
4. License
5. Contact

Getting Started

1. Clone the repo

   git clone https://github.com/jeffersonroth/mdbook-environment.git

2. Build the docker image locally:

   docker build -t local-mdbook-base-image .

3. Serve the example book locally

   docker compose up

4. Check the rendered book in localhost

Development

Before pushing your local branch:

1. Build the docker image locally:

   docker build -t local-mdbook-base-image .

2. Serve the example book locally:

   docker compose up --force-recreate --build

3. Review the content in localhost

4. Push changes to Docker Hub

   sh ./dockerhub-deploy.sh

Dependencies

Docker Image

Docker image used to build the book in html.

• jeffroth/mdbook-environment

mdBook Plugins

mdBook plugins to generate table of contents, render Mermaid diagrams, etc.

• mdbook:
  • User Guide
• mdbook-toc:
  • Repo
• mdbook-footnote
  • Repo
• mdbook-emojicodes
  • Repo
• mdbook-mermaid
  • Repo
• mdbook-plantuml
  • Repo
• mdbook-admonish
• mdbook-catppuccin
• mdbook-i18n-helpers:
  • User Guide
• mdbook-reference-table
• mdbook-linkcheck
• mdbook-i18n
• mdbook-svgbob
• mdbook-man
• mdbook-pdf
• mdbox-katex
• mdbook-epub
• mdbook-template
• mdbook-utils

Markdown Examples

• lorem-markdownum

License

Copyright (C) 2024 Jefferson Johannes Roth Filho. See LICENSE for more information.

Contact

Jefferson Roth - jjrothfilho@gmail.com

Project Link: https://hub.docker.com/r/jeffroth/mdbook-environment