Trait mdbook::preprocess::Preprocessor

pub trait Preprocessor {
    fn name(&self) -> &str;
    fn run(&self, ctx: &PreprocessorContext, book: &mut Book) -> Result<()>;
}

An operation which is run immediately after loading a book into memory and before it gets rendered.

Required Methods

fn name(&self) -> &str

Get the Preprocessor's name.

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

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

Implementors

• impl Preprocessor for LinkPreprocessor