Crate mdbook_termlink 

mdbook-termlink

An mdBook preprocessor that automatically links glossary terms throughout documentation.

Features

• Parses glossary terms from definition list markdown
• Auto-links first occurrence of each term per page
• Configurable via book.toml
• Skips code blocks, inline code, existing links, and headings
• Supports case-insensitive matching
• Custom CSS class for styled links

Usage

Add to your book.toml:

[preprocessor.termlink]
glossary-path = "reference/glossary.md"
link-first-only = true
css-class = "glossary-term"
case-sensitive = false

Glossary Format

Use standard markdown definition lists:

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

REST
: Representational State Transfer.

Re-exports

pub use config::Config;

Modules

config

Configuration parsing for the termlink preprocessor.

Structs

Term

A glossary term extracted from a definition list.

TermlinkPreprocessor

mdBook preprocessor that auto-links glossary terms throughout documentation.