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

Introduction

Welcome to the mdBook Getting Started Guide.

mdBook is a command-line tool for creating books from Markdown files. It is written in Rust and produces clean, navigable HTML output that is ideal for project documentation, tutorials, and technical books.

In this guide you will learn how to:

  1. Install mdBook using mise for reproducible tooling
  2. Create a new book project
  3. Configure your book
  4. Write content in Markdown
  5. Build and deploy to GitHub Pages with a GitHub Actions workflow