mdbook

Create book from markdown files

mdBook is ideal for creating product or API documentation, tutorials, course materials or anything that requires a clean, easily navigable and customizable presentation. It features:

An integrated search support
Color syntax highlighting for code blocks for many different languages
Theme files allow customizing the formatting of the output
Preprocessors that provide extensions for custom syntax and modifying content
Backends that can render the output to multiple formats

terminal

https://rust-lang.github.io/mdBook/

amd64

Installation

1. Add WakeMeOps repository

curl -sSL https://raw.githubusercontent.com/upciti/wakemeops/main/assets/install_repository | sudo bash

2. Install mdbook

sudo apt install mdbook

Snippets

DockerfileGithub Action

FROM wakemeops/minideb:bullseye

RUN install_packages \
    mdbook=0.4.28*

USER 1001

- name: Install dependencies
  uses: upciti/wakemeops-action@v1
  with:
    packages: |
      mdbook=0.4.28*

Download URLs

amd64

Version	SHA256	Size (KB)
0.4.28	`57e2694f79e4410bfc7f5745179baa8068845c910003df02d1a33dde27396513`	3171
0.4.27	`b113b92c358a479f16d8fced8bef697c12436c89dbf216e3e8b40bcf8ed2468c`	3171
0.4.26	`e48f5a95661870cce717f5a08bd90e1e413538790048bc364d9a7b6cc36bfa2f`	3238
0.4.25	`9789ea98de9a1b4fc005e4bd0101c7a963e36553617080543533bd59a5410f5b`	3166
0.4.24	`e8cf14101dd40f986f67777edb85d8a0dc7dc463cda45a4031cd6f843925aec2`	3163
0.4.23	`ff0bba4c4547e0099a88c74dc069cfe56287d7290aae89f883d8d0c3feaee75a`	3163
0.4.22	`d9c6f6099ca9ebcca5dcc3b589327234692dc95ffe82e12c0191d48e1e55e8a5`	3123
0.4.21	`744a3fa932e9bde01c2acbc0b244235a403dcb85d05317384a76e444892cb5f4`	3125
0.4.20	`a3a3767343b051de8a9d90ea96c29bc3a97723b043aabe548c977cfce4aa9acf`	3125
0.4.19	`2f549cc322e07386a6d0cd5351f6c559eff62a8c052287542236b5fd88aae9b5`	3126

Blueprints

Debian packages listed on this page are generated from op2deb YAML blueprints. Blueprints for mdbook are versionned here.

Click here to see mdbook ops2deb blueprints

https://github.com/upciti/wakemeops/blob/main/blueprints/terminal/mdbook/ops2deb.yml

name: mdbook
matrix:
  versions:
    - 0.4.19
    - 0.4.20
    - 0.4.21
    - 0.4.22
    - 0.4.23
    - 0.4.24
    - 0.4.25
    - 0.4.26
    - 0.4.27
    - 0.4.28
homepage: https://rust-lang.github.io/mdBook/
summary: create book from markdown files
description: |-
  mdBook is ideal for creating product or API documentation, tutorials, course
  materials or anything that requires a clean, easily navigable and customizable
  presentation. It features:

  * An integrated search support
  * Color syntax highlighting for code blocks for many different languages
  * Theme files allow customizing the formatting of the output
  * Preprocessors that provide extensions for custom syntax and modifying content
  * Backends that can render the output to multiple formats
fetch: https://github.com/rust-lang/mdBook/releases/download/v{{version}}/mdbook-v{{version}}-x86_64-unknown-linux-gnu.tar.gz
install:
  - mdbook:/usr/bin/

The blueprint fetch keyword contains a URL template pointing to mdbook releases. Downloaded files are locked in a lockfile versionned here.

Click here to see mdbook release hashes

https://github.com/upciti/wakemeops/blob/main/blueprints/terminal/mdbook/ops2deb.lock.yml

- url: https://github.com/rust-lang/mdBook/releases/download/v0.4.19/mdbook-v0.4.19-x86_64-unknown-linux-gnu.tar.gz
  sha256: 50a419363d8233f42a038ff3c5d977d44b7cb7f860f34b4567161241642aec9a
  timestamp: 2022-07-02 04:05:41+00:00
- url: https://github.com/rust-lang/mdBook/releases/download/v0.4.20/mdbook-v0.4.20-x86_64-unknown-linux-gnu.tar.gz
  sha256: 77e49898e2570370d30d0221393f6114ab66ad138ef4e9e2da2a5e652a090255
  timestamp: 2022-07-15 04:28:13+00:00
- url: https://github.com/rust-lang/mdBook/releases/download/v0.4.21/mdbook-v0.4.21-x86_64-unknown-linux-gnu.tar.gz
  sha256: ec3c978a255b444987fd6e0805147f4ea75d221f68c6e27dbf3e8a28aba166b7
  timestamp: 2022-07-22 20:29:17+00:00
- url: https://github.com/rust-lang/mdBook/releases/download/v0.4.22/mdbook-v0.4.22-x86_64-unknown-linux-gnu.tar.gz
  sha256: da87650f1e996fb04e87a126bd70823c0ed744e7e8e32d5530213aa22619e232
  timestamp: 2022-11-28 19:26:02+00:00
- url: https://github.com/rust-lang/mdBook/releases/download/v0.4.23/mdbook-v0.4.23-x86_64-unknown-linux-gnu.tar.gz
  sha256: cc00c5b65de359df7563ec26a108a6ccbf0c6b8098bba6e453892ccba8444e4f
  timestamp: 2022-12-15 04:24:59+00:00
- url: https://github.com/rust-lang/mdBook/releases/download/v0.4.24/mdbook-v0.4.24-x86_64-unknown-linux-gnu.tar.gz
  sha256: 6f1db6fe5de2463be21fa6115c3ab87f71407064e60f420be6046a773caf5831
  timestamp: 2022-12-15 19:22:06+00:00
- url: https://github.com/rust-lang/mdBook/releases/download/v0.4.25/mdbook-v0.4.25-x86_64-unknown-linux-gnu.tar.gz
  sha256: 2d049e4d0a1ef739a1218cf209c99cdc0d1c66aa43a15e2183770f6e1d333324
  timestamp: 2022-12-17 19:21:10+00:00
- url: https://github.com/rust-lang/mdBook/releases/download/v0.4.26/mdbook-v0.4.26-x86_64-unknown-linux-gnu.tar.gz
  sha256: 87788cfa7f995841c2a4609d3a0d3b02d1eb90e1ab439d644a52c24ce354ac9c
  timestamp: 2023-02-10 04:27:33+00:00
- url: https://github.com/rust-lang/mdBook/releases/download/v0.4.27/mdbook-v0.4.27-x86_64-unknown-linux-gnu.tar.gz
  sha256: 05aff497ac7d099b76b96d9816ebbfe29014a3d32c1488ffc486982335f46163
  timestamp: 2023-02-14 02:44:06+00:00
- url: https://github.com/rust-lang/mdBook/releases/download/v0.4.28/mdbook-v0.4.28-x86_64-unknown-linux-gnu.tar.gz
  sha256: 7de923905701123c6590536108beefc085258132fc1ba212c0fa6439bd638e46
  timestamp: 2023-03-05 17:37:13+00:00

Badge

MarkdownHTMLRST

[![WakeMeOps](https://docs.wakemeops.com/badges/mdbook.svg)](https://docs.wakemeops.com/packages/mdbook)

<a href="https://docs.wakemeops.com/packages/mdbook">
  <img src="https://docs.wakemeops.com/badges/mdbook.svg"/>
</a>

.. image:: https://docs.wakemeops.com/badges/mdbook.svg
:target: https://docs.wakemeops.com/packages/mdbook