# Install mdbook with Homebrew, apk, apt, MacPorts, Nix, pacman, scoop, winget, zypper 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: local Homebrew formula metadata - MacPorts (94%): ```sh sudo port install mdbook ``` Evidence: MacPorts ports tree: textproc/mdbook/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1 ### Linux - apk (92%): ```sh sudo apk add mdbook ``` Evidence: Alpine Linux edge package indexes: mdbook from https://dl-cdn.alpinelinux.org/alpine/edge/community/x86_64/APKINDEX.tar.gz - Debian apt (92%): ```sh sudo apt install librust-mdbook-dev ``` Evidence: Debian stable package indexes: librust-mdbook-dev from https://deb.debian.org/debian/dists/stable/main/binary-amd64/Packages.xz - Nix (92%): ```sh nix profile install nixpkgs#mdbook ``` Evidence: nixpkgs package indexes: pkgs/by-name/md/mdbook/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1 - pacman (92%): ```sh sudo pacman -S mdbook ``` Evidence: Arch Linux sync databases: mdbook from https://geo.mirror.pkgbuild.com/extra/os/x86_64/extra.db.tar.gz - zypper (92%): ```sh sudo zypper install mdbook ``` Evidence: openSUSE Tumbleweed package metadata: mdbook from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst ### Windows - Scoop (92%): ```sh scoop install main/mdbook ``` Evidence: Scoop official bucket manifest trees: bucket/mdbook.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1 - winget (92%): ```sh winget install --id Rustlang.mdBook -e ``` Evidence: Windows Package Manager source index: Rustlang.mdBook from https://cdn.winget.microsoft.com/cache/source.msix ## Package facts - **Package key:** brew:mdbook - **Package manager:** Homebrew - **Package manager page:** - **Version:** 0.5.4 - **Source summary:** Create modern online books from Markdown files - **Homepage:** - **Repository:** - **Upstream docs:** - **License:** MPL-2.0 - **Source archive:** - **Last updated:** 2026-07-06T21:38:51Z - **Generated:** 2026-07-09T07:20:21+00:00 ## Executables - mdbook (cli) - mdbook (alias) ## Build dependencies - rust ## Install behavior - Post-install hook: not defined - Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux ## Freshness - Page generated: 2026-07-09 - Package-manager version: 0.5.4 - Package-manager updated: 2026-07-06 - Local data: ok - Upstream repository: https://github.com/rust-lang/mdBook - Upstream latest detected: v0.5.4 (current) ## 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 - - - - - 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 ## Source Database Details - **Source Database:** Homebrew formula API - **Tap:** homebrew/core - **Full Name:** mdbook - **Version Scheme:** 0 - **Revision:** 0 - **Head Version:** HEAD - **Bottle Stable Root URL:** - **Deprecated:** no - **Disabled:** no - **Keg Only:** no - **URL Keys:** head, stable ## Other Package-Manager Records - Debian apt - librust-mdbook-dev - 0.4.48+ds-2: normalized package name match | Debian stable package indexes: librust-mdbook-dev from https://deb.debian.org/debian/dists/stable/main/binary-amd64/Packages.xz | Markdown book creator tool - Rust source code | https://rust-lang.github.io/mdBook/ - Debian apt - mdbook - 0.4.48+ds-2: normalized package name match | Debian stable package indexes: mdbook from https://deb.debian.org/debian/dists/stable/main/binary-amd64/Packages.xz | Markdown book creator tool | https://rust-lang.github.io/mdBook/ - Nix - mdbook: normalized package name match | nixpkgs package indexes: pkgs/by-name/md/mdbook/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1 - apk - mdbook - 0.5.3-r0: normalized package name match | Alpine Linux edge package indexes: mdbook from https://dl-cdn.alpinelinux.org/alpine/edge/community/x86_64/APKINDEX.tar.gz | mdBook is a utility to create modern online books from Markdown files | https://rust-lang.github.io/mdBook/ - apk - mdbook-bash-completion - 0.5.3-r0: normalized package name match | Alpine Linux edge package indexes: mdbook-bash-completion from https://dl-cdn.alpinelinux.org/alpine/edge/community/x86_64/APKINDEX.tar.gz | Bash completions for mdbook | https://rust-lang.github.io/mdBook/ - apk - mdbook-fish-completion - 0.5.3-r0: normalized package name match | Alpine Linux edge package indexes: mdbook-fish-completion from https://dl-cdn.alpinelinux.org/alpine/edge/community/x86_64/APKINDEX.tar.gz | Fish completions for mdbook | https://rust-lang.github.io/mdBook/ - apk - mdbook-zsh-completion - 0.5.3-r0: normalized package name match | Alpine Linux edge package indexes: mdbook-zsh-completion from https://dl-cdn.alpinelinux.org/alpine/edge/community/x86_64/APKINDEX.tar.gz | Zsh completions for mdbook | https://rust-lang.github.io/mdBook/ - pacman - mdbook - 0.5.3-1: normalized package name match | Arch Linux sync databases: mdbook from https://geo.mirror.pkgbuild.com/extra/os/x86_64/extra.db.tar.gz | Create book from markdown files, like Gitbook but implemented in Rust | https://github.com/rust-lang/mdBook - zypper - mdbook - 0.4.49-1.2: normalized package name match | openSUSE Tumbleweed package metadata: mdbook from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst | Create books from markdown | https://github.com/rust-lang/mdBook - MacPorts - mdbook: normalized package name match | MacPorts ports tree: textproc/mdbook/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1 - Scoop - main/mdbook: normalized package name match | Scoop official bucket manifest trees: bucket/mdbook.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1 - winget - Rustlang.mdBook: normalized package name match | Windows Package Manager source index: Rustlang.mdBook from https://cdn.winget.microsoft.com/cache/source.msix ## Related links - [Source-control packages](https://www.automicvault.com/pkg/source-control-tools/) - Belongs to a source-control command family. - [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata. - [Text processing packages](https://www.automicvault.com/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata. - [Developer build packages](https://www.automicvault.com/pkg/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata. - [rust](https://www.automicvault.com/pkg/brew/rust/) - Build dependency declared by Homebrew. - [docfx](https://www.automicvault.com/pkg/brew/docfx/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown, static-site-generator. - [docmd](https://www.automicvault.com/pkg/brew/docmd/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown, static-site-generator. - [action-docs](https://www.automicvault.com/pkg/brew/action-docs/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [cargo-docset](https://www.automicvault.com/pkg/brew/cargo-docset/) - Shares av.db curated category or tags: cli, developer-tools, documentation, rust. - [github-markdown-toc](https://www.automicvault.com/pkg/brew/github-markdown-toc/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [go-md2man](https://www.automicvault.com/pkg/brew/go-md2man/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [grip](https://www.automicvault.com/pkg/brew/grip/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [gtree](https://www.automicvault.com/pkg/brew/gtree/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [get-llms-txt](https://www.automicvault.com/pkg/npm/get-llms-txt/) - Both packages work with overlapping file formats or content types. Shared terms: cli, developer, developer-tools, documentation, files. ## 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 - package-page enrichment - curated configuration and credential file locations - curated package history - package version freshness - av.db category and tag curation - package relationship graph - external package-manager database matches - cross-ecosystem install command graph