Crate mdbook_termlink 

mdbook-termlink

An mdBook preprocessor that automatically links every glossary term throughout the book.

Quick start

Add to your book.toml:

[preprocessor.termlink]
glossary-path = "reference/glossary.md"
display-mode  = "link"     # or "tooltip", or "both"

Write the glossary as a Markdown definition list:

API (Application Programming Interface)
: A set of protocols for building software.

REST
: Representational State Transfer.

Build the book with mdbook build. Every chapter will have its terms linked into the glossary.

Library entry points

The public API is intentionally narrow:

• TermlinkPreprocessor — the Preprocessor trait implementation.
• Config — parsed book.toml settings, including DisplayMode.
• TermlinkError — the typed error returned by every fallible operation.

Structs

Config

Configuration for the termlink preprocessor.

TermlinkPreprocessor

mdBook preprocessor that auto-links glossary terms throughout documentation.

Enums

DisplayMode

Output shape chosen for every linked glossary occurrence.

TermlinkError

Every way the termlink preprocessor can fail.