Automic VaultAutomic Vault

brew

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 commandSecurity notes

install

Additional install commands

macOS

Homebrewverified · 100%
brew install mdbook

local Homebrew formula metadata

MacPortsverified · 94%
sudo port install mdbook

MacPorts ports tree · textproc/mdbook/Portfile · source: api.github.com

Linux

Alpine Linux apkverified · 92%
sudo apk add mdbook

Alpine Linux edge package indexes · mdbook · source: dl-cdn.alpinelinux.org

Debian aptverified · 92%
sudo apt install librust-mdbook-dev

Debian stable package indexes · librust-mdbook-dev · source: deb.debian.org

Nixverified · 92%
nix profile install nixpkgs#mdbook

nixpkgs package indexes · pkgs/by-name/md/mdbook/package.nix · source: api.github.com

Arch Linux pacmanverified · 92%
sudo pacman -S mdbook

Arch Linux sync databases · mdbook · source: geo.mirror.pkgbuild.com

openSUSE zypperverified · 92%
sudo zypper install mdbook

openSUSE Tumbleweed package metadata · mdbook · source: download.opensuse.org

Windows

Scoopverified · 92%
scoop install main/mdbook

Scoop official bucket manifest trees · bucket/mdbook.json · source: api.github.com

Windows Package Managerverified · 92%
winget install --id Rustlang.mdBook -e

Windows Package Manager source index · Rustlang.mdBook · source: cdn.winget.microsoft.com

overview

Package summary

Create modern online books from Markdown files

Commands and aliases

  • mdbook

history

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.

security posture

No protected-tool coverage found yet

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.

Install behavior

  • No Homebrew post-install hook is recorded in formula metadata.
  • Homebrew bottle metadata is available for 6 platform targets.
  • Build metadata lists 1 build dependencies.

Recommended review

Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.

local files

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

Config paths the tool may read or write during local use.

Unix
book.toml

executables

Installed executables

CommandKindExposureNote
mdbookcliglobal executable

freshness

Version and freshness

These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.

page generated2026-07-08
manager version0.5.4
manager updated2026-07-06
local dataok
upstreamcurrent
latest detectedv0.5.4

https://github.com/rust-lang/mdBook

  • okNo freshness warnings were generated.

install metadata

Package metadata

Package keybrew:mdbook
Version0.5.4
Package managerHomebrew
Package manager pagehttps://formulae.brew.sh/formula/mdbook
Homepagehttps://rust-lang.github.io/mdBook/
Repositoryhttps://github.com/rust-lang/mdBook
Upstream docshttps://rust-lang.github.io/mdBook
LicenseMPL-2.0
Source archivehttps://github.com/rust-lang/mdBook/archive/refs/tags/v0.5.4.tar.gz
Last updated2026-07-06T21:38:51Z
Pulseupdated
Build dependenciesrust
Bottleavailable (on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux)
Homebrew post-installnot defined
Servicenone declared

registry facts

Source database details

Source DatabaseHomebrew formula API
Taphomebrew/core
Full Namemdbook
Version Scheme0
Revision0
Head VersionHEAD
Bottle Stable Root URLhttps://ghcr.io/v2/homebrew/core
Deprecatedno
Disabledno
Keg Onlyno
URL Keys
  • head
  • stable

source database matches

Other package-manager records

Matches are pulled from external package-manager indexes and kept separate from local Automic Vault package links.

Debian apt95%

librust-mdbook-dev 0.4.48+ds-2

Markdown book creator tool - Rust source code

https://rust-lang.github.io/mdBook/

sudo apt install librust-mdbook-dev
  • Section: rust
  • Architecture: amd64
  • Source Package: mdbook
  • 32 dependencies
  • normalized package name match
  • Matched by: Mdbook
Debian stable package indexes · deb.debian.org · Debian stable package indexes: librust-mdbook-dev from https://deb.debian.org/debian/dists/stable/main/binary-amd64/Packages.xz
Debian apt95%

mdbook 0.4.48+ds-2

Markdown book creator tool

https://rust-lang.github.io/mdBook/

sudo apt install mdbook
  • Section: utils
  • Architecture: amd64
  • 2 dependencies
  • normalized package name match
  • Matched by: Mdbook
Debian stable package indexes · deb.debian.org · Debian stable package indexes: mdbook from https://deb.debian.org/debian/dists/stable/main/binary-amd64/Packages.xz
Nix95%

mdbook

nix profile install nixpkgs#mdbook
  • normalized package name match
  • Matched by: Mdbook
nixpkgs package indexes · api.github.com · nixpkgs package indexes: pkgs/by-name/md/mdbook/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1
apk95%

mdbook 0.5.3-r0

mdBook is a utility to create modern online books from Markdown files

https://rust-lang.github.io/mdBook/

sudo apk add mdbook
  • License: MPL-2.0
  • Architecture: x86_64
  • Source Package: mdbook
  • 1 dependencies
  • 1 provides
  • normalized package name match
  • Matched by: Mdbook
Alpine Linux edge package indexes · dl-cdn.alpinelinux.org · Alpine Linux edge package indexes: mdbook from https://dl-cdn.alpinelinux.org/alpine/edge/community/x86_64/APKINDEX.tar.gz
apk95%

mdbook-bash-completion 0.5.3-r0

Bash completions for mdbook

https://rust-lang.github.io/mdBook/

sudo apk add mdbook-bash-completion
  • License: MPL-2.0
  • Architecture: x86_64
  • Source Package: mdbook
  • normalized package name match
  • Matched by: Mdbook
Alpine Linux edge package indexes · dl-cdn.alpinelinux.org · Alpine Linux edge package indexes: mdbook-bash-completion from https://dl-cdn.alpinelinux.org/alpine/edge/community/x86_64/APKINDEX.tar.gz
apk95%

mdbook-fish-completion 0.5.3-r0

Fish completions for mdbook

https://rust-lang.github.io/mdBook/

sudo apk add mdbook-fish-completion
  • License: MPL-2.0
  • Architecture: x86_64
  • Source Package: mdbook
  • normalized package name match
  • Matched by: Mdbook
Alpine Linux edge package indexes · dl-cdn.alpinelinux.org · Alpine Linux edge package indexes: mdbook-fish-completion from https://dl-cdn.alpinelinux.org/alpine/edge/community/x86_64/APKINDEX.tar.gz
apk95%

mdbook-zsh-completion 0.5.3-r0

Zsh completions for mdbook

https://rust-lang.github.io/mdBook/

sudo apk add mdbook-zsh-completion
  • License: MPL-2.0
  • Architecture: x86_64
  • Source Package: mdbook
  • normalized package name match
  • Matched by: Mdbook
Alpine Linux edge package indexes · dl-cdn.alpinelinux.org · Alpine Linux edge package indexes: mdbook-zsh-completion from https://dl-cdn.alpinelinux.org/alpine/edge/community/x86_64/APKINDEX.tar.gz
pacman95%

mdbook 0.5.3-1

Create book from markdown files, like Gitbook but implemented in Rust

https://github.com/rust-lang/mdBook

sudo pacman -S mdbook
  • License: MPL2
  • Architecture: x86_64
  • 1 dependencies
  • normalized package name match
  • Matched by: Mdbook
Arch Linux sync databases · geo.mirror.pkgbuild.com · Arch Linux sync databases: mdbook from https://geo.mirror.pkgbuild.com/extra/os/x86_64/extra.db.tar.gz
zypper95%

mdbook 0.4.49-1.2

Create books from markdown

https://github.com/rust-lang/mdBook

sudo zypper install mdbook
  • License: (Apache-2.0 OR MIT) AND Unicode-DFS-2016 AND (Apache-2.0 OR BSL-1.0) AND (Apache-2.0 OR ISC OR MIT) AND (Apache-2.0 OR MIT) AND (Apache-2.0 OR Apache-2.0 WITH
  • Category: Unspecified
  • Architecture: x86_64
  • Source Package: mdbook
  • 4 dependencies
  • 2 provides
  • normalized package name match
  • Matched by: Mdbook
openSUSE Tumbleweed package metadata · download.opensuse.org · openSUSE Tumbleweed package metadata: mdbook from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst
MacPorts95%

mdbook

sudo port install mdbook
  • normalized package name match
  • Matched by: Mdbook
MacPorts ports tree · api.github.com · MacPorts ports tree: textproc/mdbook/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1
Scoop95%

main/mdbook

scoop install main/mdbook
  • normalized package name match
  • Matched by: Mdbook
Scoop official bucket manifest trees · api.github.com · Scoop official bucket manifest trees: bucket/mdbook.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1
winget95%

Rustlang.mdBook

winget install --id Rustlang.mdBook -e
  • normalized package name match
  • Matched by: Mdbook
Windows Package Manager source index · cdn.winget.microsoft.com · Windows Package Manager source index: Rustlang.mdBook from https://cdn.winget.microsoft.com/cache/source.msix

package graph

Links come from deterministic package relationships, av.db category and tag curation, ecosystem matches, and package hub membership.

Related tools

  • rustBuild dependency declared by Homebrew.

Same workflow

  • docfxShares av.db curated category or tags: cli, developer-tools, documentation, markdown, static-site-generator.
  • docmdShares av.db curated category or tags: cli, developer-tools, documentation, markdown, static-site-generator.
  • action-docsShares av.db curated category or tags: cli, developer-tools, documentation, markdown.
  • cargo-docsetShares av.db curated category or tags: cli, developer-tools, documentation, rust.
  • github-markdown-tocShares av.db curated category or tags: cli, developer-tools, documentation, markdown.
  • go-md2manShares av.db curated category or tags: cli, developer-tools, documentation, markdown.

source trail

Generated from repository data

This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.

Used sources

  • Geiger risk classifier
  • Nucleus package database
  • av.db category and tag curation
  • cross-ecosystem install command graph
  • curated configuration and credential file locations
  • curated package history
  • external package-manager database matches
  • package relationship graph
  • package version freshness
  • package-page enrichment