# Install mdbook with Homebrew

Create modern online books from Markdown files. Version 0.5.4 via Homebrew; verified 2026-07-06.

## Install

```sh
sudo av install brew:mdbook
```

Additional install commands:

### macOS

- Homebrew (100%):

```sh
brew install mdbook
```

  Evidence: provider-native install command

## Package facts

- **Package key:** brew:mdbook
- **Package manager:** Homebrew
- **Version:** 0.5.4
- **Source summary:** Create modern online books from Markdown files
- **Homepage:** <https://rust-lang.github.io/mdBook/>
- **Repository:** <https://github.com/rust-lang/mdBook>
- **Last updated:** 2026-07-06T21:38:51Z
- **Generated:** 2026-08-03T00:40:33+00:00

## Executables

- mdbook (alias)

## Install behavior

- Bottle: not available

## Freshness

- Page generated: 2026-08-03
- Package-manager version: 0.5.4
## Project history and usage

mdBook is the Rust project's Markdown-based static book generator. The upstream README describes it as a utility for creating modern online books from Markdown files, and the GitHub repository description summarizes it as like GitBook but implemented in Rust.

### Project history

The official GitHub repository was created on 2015-07-07. mdBook grew in the Rust ecosystem as a documentation-oriented command-line tool: books are initialized with `mdbook init`, configured with `book.toml`, organized with `src/SUMMARY.md`, and rendered or served with commands such as `mdbook build` and `mdbook serve`.

The official user guide is itself an mdBook output, so the documentation doubles as a demonstration of the generated site format. The repository has continued active releases, with the GitHub releases API showing v0.5.3 published on 2026-05-19.

### Adoption history

The supplied package-manager metadata shows mdBook in Homebrew, Alpine, Debian, MacPorts, Nix, Arch, Scoop, winget, and openSUSE. That broad packaging matches its use as a documentation build tool rather than only as a Rust crate.

Within package-manager culture, mdBook became familiar because it appears in source trees and documentation build pipelines: installing `mdbook` is often enough to preview or publish a project's manual locally.

### How it is used

A typical workflow is `mdbook init my-first-book`, edit Markdown files under `src`, maintain the chapter tree in `src/SUMMARY.md`, and run `mdbook serve --open` for live rebuilding and browser refresh. Publishing uses `mdbook build` to generate a `book` directory of static HTML.

The book configuration file is `book.toml` at the book root. The official guide describes it as TOML and shows a minimal `[book]` table with a title.

### Why package nerds care

mdBook matters to package maintainers because it turned documentation into a reproducible command-line build artifact. Instead of relying on a hosted wiki or a JavaScript-heavy documentation system, projects can build a static manual from Markdown with one packaged binary.

It is also a visible Rust ecosystem tool: it uses Rust's distribution channels and is packaged widely enough that documentation builds can depend on the system package manager instead of a project-local install step.

### Timeline

- 2015-07-07: Official GitHub repository created.
- 2010s: mdBook established the `book.toml` plus `src/SUMMARY.md` structure documented in the official guide.
- 2026-05-19: GitHub releases API lists v0.5.3 published.

### Related projects

- The repository description explicitly compares mdBook to GitBook while emphasizing that mdBook is implemented in Rust.
- The official guide links the book format to Markdown content, TOML configuration, and static HTML publishing.

### Sources

- <https://api.github.com/repos/rust-lang/mdBook>
- <https://api.github.com/repos/rust-lang/mdBook/releases?per_page=15>
- <https://github.com/rust-lang/mdBook#readme>
- <https://rust-lang.github.io/mdBook>
- source_facts.package-manager


## Security Notes

No matching local secret-handling manifest was found for mdbook. Nucleus package metadata is still published here so future coverage has a stable package URL.



## Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.


## Configuration files

- Unix: book.toml

## Combined YAML source

View the package source record on GitHub. [combined/mdbook.yml](https://github.com/automic-vault/db/blob/main/combined/mdbook.yml)


## Sources

- Nucleus package database
- Geiger risk classifier
- curated configuration and credential file locations
- curated package history
- pkgdb category and tag curation