mdBook
CLICompiles Markdown chapters into an online book with a table of contents, full-text search and themes, good for manuals, lecture notes and course material; agents can edit chapter files and rebuild to preview. Maintained by the Rust team; install a prebuilt binary or via cargo.
mdBook
mdBook is a utility to create modern online books from Markdown files.
Check out the User Guide for a list of features and installation and usage information. The User Guide also serves as a demonstration to showcase what a book looks like.
If you are interested in contributing to the development of mdBook, check out the Contribution Guide.
License
All the code in this repository is released under the Mozilla Public License v2.0, for more information take a look at the LICENSE file.
Related resources
Hugo
CLIStatic site generator written in Go that builds Markdown content into docs sites, blogs or landing pages in seconds, with a local preview server and an asset pipeline for images, CSS and JS.
gohugoio/hugo90.1k
Vale
CLIA prose linter that checks docs against style guides: use ready-made packages like Microsoft and Google or write your own YAML rules. It parses Markdown, AsciiDoc and other formats before checking, runs fully offline, and plugs into editors and CI.
vale-cli/vale6.2k
Jupyter Book
CLIBuilds Markdown and Jupyter notebooks into online textbook sites with a TOC, math, citations and cross-references, plus publication-quality PDF export; popular for course notes. A Jupyter subproject installed via pipx or npm; PDF export needs Typst or LaTeX.
jupyter-book/jupyter-book4.3k
textlint
CLIPluggable natural-language linter that checks Markdown and plain text for wording, punctuation and terminology consistency like code, with auto-fix, and can also run as an MCP server. Rules are installed separately, mostly for Japanese and English; requires Node.js 20+.
textlint/textlint3.2k
Asciidoctor
CLIConverts AsciiDoc, a Markdown-like plain-text markup, into HTML5, DocBook and man pages, and with official extensions into PDF and EPUB, suited to technical books, textbooks and large manuals. Ruby-based; install with Homebrew on macOS.
asciidoctor/asciidoctor5.2k
AutoCorrect
CLIFixes spacing and full-width/half-width punctuation in mixed CJK and English text, understanding 28+ file types including Markdown, YAML and strings and comments in source code. Lint mode outputs a diff or JSON for CI checks on localized copy.
huacnlee/autocorrect1.7k