'mdBook' pre-processors

Preprocessors Used in the Book

This book is built from its markdown sources using mdbook↗.

The bk/book.toml↗ config file configures several mdbook preprocessors↗ and backends↗.

• mdbook-private↗ hides private sections and chapters in the book.
• mdbook-scrub is a custom preprocessor written specifically for this book. See below.
• mdbook-indexing↗ builds a word index via annotations in the book's Markdown.
• mdbook-linkcheck↗ is a backend↗ that checks (internal) links. Install with cargo install mdbook-linkcheck. Un-comment the related section in book.toml↗.
• The default html↗ backend is used to generate the HTML for deployment on GitHub Pages.

The mdbook chapter describes these preprocessors and backends in more detail.

mdbook-scrub

mdbook-scrub↗ is a custom preprocessor↗ written specifically for this book. It is a simple tool that

• removes the hidden sections between from the markdown before rendering. By default, mdbook↗ hides
  sections, but they remain searchable.
• removes {{#includes }}↗}} that points to hidden files (files that start with _), if any. This feature fixes a gap of mdbook-private.

Consult the project's README↗ for more details.