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

Prerequisites

Before getting started, you need Git and mise installed on your system.

Git

Install Git if you do not already have it:

OSCommand
macOSxcode-select --install
Debian/Ubuntusudo apt install git
Fedorasudo dnf install git

mise

mise is a polyglot tool-version manager. It lets you pin exact tool versions per project so that every contributor uses the same setup.

Install mise:

curl https://mise.run | sh

Then activate it in your shell. Add one of the following to your shell configuration file (~/.bashrc, ~/.zshrc, etc.):

# Bash
eval "$(~/.local/bin/mise activate bash)"

# Zsh
eval "$(~/.local/bin/mise activate zsh)"

# Fish
~/.local/bin/mise activate fish | source

Restart your shell (or source the config file) and verify:

mise --version

What mise will manage

In this guide mise installs and manages mdBook so you do not need Rust or Cargo on your machine. The exact version is pinned in mise.toml at the project root.