1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
//! # mdbook-termlink
//!
//! An [mdBook](https://github.com/rust-lang/mdBook) preprocessor that
//! automatically links every glossary term throughout the book.
//!
//! ## Quick start
//!
//! Add to your `book.toml`:
//!
//! ```toml
//! [preprocessor.termlink]
//! glossary-path = "reference/glossary.md"
//! display-mode = "link" # or "tooltip", or "both"
//! ```
//!
//! Write the glossary as a Markdown definition list:
//!
//! ```markdown
//! 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.
pub use ;
pub use TermlinkError;
pub use TermlinkPreprocessor;