Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Mdbook


Crates.io

Install

cargo install mdbook

TLDR

  Create online books by writing Markdown files.
  More information: <https://rust-lang.github.io/mdBook/>.

  Create an mdbook project in the current directory:

      mdbook init

  Create an mdbook project in a specific directory:

      mdbook init path/to/directory

  Clean the directory with the generated book:

      mdbook clean

  Serve a book at <http://localhost:3000>, auto build when file changes:

      mdbook serve

  Watch a set of Markdown files and automatically build when a file is changed:

      mdbook watch