Introduction

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 includes by the file contents.

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

mdbook-utils (GitHub repo) (docs.rs) (crates.io) (user guide - this book)