#markdown #mdbook #documentation #book #broken-links #rust-book #file-content

bin+lib mdbook-utils

Tools to manage links, reference definitions, and code examples in Markdown files, especially mdbook source directories

4 releases

0.1.3 Feb 21, 2024
0.1.2 Feb 6, 2024
0.1.1 Feb 5, 2024
0.1.0 Feb 4, 2024

#2258 in Parser implementations

MIT/Apache

135KB
2.5K SLoC

mdBook Utilities

This is a Work In Progress. The command-line interface (CLI) and underlying API are subject to change. A summary of recently released changes is found in RELEASES.md. You may also consult TODO.md.

What is mdbook-utils? What is it used for?

The mdbook-utils command-line tool manages links, reference definitions, and code blocks in large collections of Markdown files, especially mdbook source directories. It is the companion tool for the Rust How-to book (github).

mdbook-utils is useful for the following:

  • centralize all reference definitions in one file to make Markdown files more readable and ease link maintenance,
  • replace simple Markdown links by badges,
  • identify duplicate or broken links,
  • generate a sitemap file for your book or website,
  • extract fenced code bocks embedded into the Markdown to separate files for easier formatting, debugging and testing,
  • replace code examples by mdBook #include statements,
  • conversely replace mdBook includes by the file contents.

Installation and Usage

Consult the User Guide for installation and usage instructions.

Public API

mdbook-utils' underlying library also exposes a public API that may be used from your code.

mdbook-utils (github) (docs.rs) (crates.io) (user guide)

Dependencies

~11–20MB
~276K SLoC