`mdBook`

Recipe	Crates	Categories
Write Online Books with `mdBook`
`mdbook` plugins
Deploy Your Book or Documentation via a CD / CI Pipeline	GitHub Actions for mdBook
Let Readers Execute Sample Code in the Rust Playground
Preprocess your Book via Arbitrary Commands with `mdbook-cmdrun`
Create a Journal with `mdbook-journal`
Check Links with `mdbook-linkcheck`
`mdbook-pagetoc`
Hide Entire Chapters with `mdbook-private`
Hide Pages with `mdbook-hide`
Create Pages from a Template with `mdbook-tera`
`mdbook-theme`
`mdbook-toc`
Test Code in Your `mdbook`	Byron-termbook
Replace Text in Chapters with `yapp`

Write Online Books with `mdBook`

mdBook⮳ is a utility to create modern online books from Markdown files.

cargo install mdbook

mdbook serve --open

Let Readers Execute Sample Code in the Rust Playground

Playground (Rust by example)⮳.

Augment `mdbook` with Plugins

mdbook⮳ has a large number of third-party plugins⮳.

Check Links with `mdbook-linkcheck`

mdbook-linkcheck⮳ is a backend for mdbook⮳, which will check your links for you.

Hide Entire Chapters with `mdbook-private`

mdbook-private⮳ is a mdbook⮳ pre-processor that controls visibility of private chapters and sections within them.

Hide Pages with `mdbook-hide`

mdbook-hide⮳ is a pre-processor for mdbook⮳ that adds support for hidden chapters.

cargo install mdbook-hide

Deploy Your Book or Documentation via a CD / CI Pipeline

GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform that allows you to automate your build, test, and deployment pipeline.

GitHub Actions for mdBook allows you to build your site with mdbook⮳. Linux (Ubuntu), macOS, and Windows are supported.

name: github pages

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  deploy:
    runs-on: ubuntu-20.04
    concurrency:
      group: ${{ github.workflow }}-${{ github.ref }}
    steps:
      - uses: actions/checkout@v2

      - name: Setup mdBook
        uses: peaceiris/actions-mdbook@v2
        with:
          mdbook-version: '0.4.10'
          # mdbook-version: 'latest'

      - run: mdbook build

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        if: ${{ github.ref == 'refs/heads/main' }}
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./book

Add a Table of Contents to Each Page

`mdbook-toc`

mdbook-toc⮳ is a pre-processor for mdbook⮳ to add inline Table of Contents support.

`mdbook-theme`

mdbook-theme⮳ is a pre-processor and a backend to config theme for mdbook, especially creating a pagetoc on the right and setting full color themes from the official ace editor.

`mdbook-pagetoc`

mdbook-pagetoc⮳ is a mdbook⮳ plugin that provides a table of contents for each page.

Create Pages from a Template

Create Pages from a Template with `mdbook-tera`

mdbook-tera⮳ is a Tera pre-processor for mdBook.

Replace Text in Chapters with `yapp`

yapp⮳ is a mdbook⮳ pre-processor that simply replaces text in chapters. Phrases to be replaced with specified content are defined in plain-text configuration file.

Create a Journal with `mdbook-journal`

mdbook-journal⮳ is a journal plugin for mdBook⮳.

Other

Preprocess your Book via Arbitrary Commands with `mdbook-cmdrun`

mdbook-cmdrun⮳ is a mdbook⮳ pre-processor to run arbitrary commands.

The Rust How-to Book