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

Create a Project

Scaffold the book

Create a directory for your book, enter it, and set up mise:

mkdir mybook && cd mybook
git init

Create a mise.toml file to pin the mdBook version:

[tools]
"aqua:rust-lang/mdBook" = "0.5.2"

Let mise install the tool:

mise install

Verify the installation:

mdbook --version

Now initialise the book:

mdbook init

When prompted, accept the defaults. This creates the following structure:

mybook/
├── book.toml
└── src/
    ├── SUMMARY.md
    └── chapter_1.md
PathPurpose
book.tomlBook metadata and configuration
src/SUMMARY.mdTable of contents — defines the chapter structure
src/chapter_1.mdYour first chapter

Preview locally

Start the built-in development server:

mdbook serve --open

This builds the book, opens it in your browser, and live-reloads whenever you save a file. The default address is http://localhost:3000.