mdbook

Create an mdbook project in the current directory

$ mdbook init

$ mdbook init [path/to/directory]

$ mdbook clean

$ mdbook serve

$ mdbook watch

mdbook subcommand [options]

build
    Build the book from the source files.

serve
    Build and serve the book locally for preview.

init
    Initialize a new book in the current directory.

test
    Run tests on your book to catch dead links and other issues.

clean
    Remove the book's output directory.

edit
    Edit book in the browser.

-h, --help
    Display help information.

-V, --version
    Display version information.

--dest-dir
    Specify the output directory (defaults to 'book').

--open
    Open the book in a browser after building (serve subcommand only).

--hostname
    Bind to a specific hostname (serve subcommand only).

--port
    Bind to a specific port (serve subcommand only).

--config
    Specify the path to the book.toml file.

--theme
    Specify a custom theme name.

mdbook is a command-line tool used to create online books from Markdown files. It's designed for ease of use, focusing on simple syntax and efficient building, offering a modern and customizable web interface. The core of a mdBook project is a book.toml file, defining configurations, and a src directory, housing Markdown content. mdbook processes these Markdown files, converting them into HTML to generate a static website suitable for online viewing. It supports features like theming, preprocessors, and rendering options, allowing for customization of the book's appearance and functionality. Its built-in server simplifies local preview and testing. mdbook proves valuable for documentation, tutorials, or any long-form content suitable for a web-based book format. It emphasizes creating accessible and maintainable books with a focus on web-friendliness.

The book.toml file configures the book.
It defines metadata like title, author, description, and specifies themes, preprocessors, and renderers.

The book's content lives inside src/ directory. The order of chapters is defined by SUMMARY.md file.

git(1)