mdBook (Markdown Book)

mdBook is a command line tool to create books with Markdown. It is ideal for creating product or API documentation, tutorials, course materials or anything that requires a clean, easily navigable and customizable presentation.

You can find the mdBook repository here: https://github.com/rust-lang/mdBook

You can find online documentation for mdBook here: https://rust-lang.github.io/mdBook/

Quickstart

Simply install mdBook from Cargo:

$ cargo install mdbook

To view a live version of the book, cd into the book directory and execute:

$ cd book
book/$ mdbook serve --open

and a web browser will open to the URL of the book. You can edit the book live and changes will be automatically detected.

To build the book for deployment to a web server, issue the following commands:

$ cd book
book/$ mdbook build

and the book will be built into the book/book/ subfolder.