Struct TermlinkPreprocessor 

pub struct TermlinkPreprocessor { /* private fields */ }

mdBook preprocessor that auto-links glossary terms throughout documentation.

Implementations

impl TermlinkPreprocessor

pub fn new(ctx: &PreprocessorContext) -> Result<Self>

Creates a new preprocessor instance from the given context.

Errors

Returns an error if the configuration in book.toml is invalid.

Trait Implementations

impl Debug for TermlinkPreprocessor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Preprocessor for TermlinkPreprocessor

fn name(&self) -> &'static str

Get the Preprocessor’s name.

fn run(&self, _ctx: &PreprocessorContext, book: Book) -> Result<Book>

Run this Preprocessor, allowing it to update the book before it is given to a renderer.

fn supports_renderer(&self, _renderer: &str) -> Result<bool, Error>

A hint to MDBook whether this preprocessor is compatible with a particular renderer.