[][src]Trait mdbook::preprocess::Preprocessor

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

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

Required methods

pub fn name(&self) -> &str[src]

Get the Preprocessor's name.

pub fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book>[src]

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

Loading content...

Provided methods

pub fn supports_renderer(&self, _renderer: &str) -> bool[src]

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

By default, always returns true.

Loading content...

Implementors

impl Preprocessor for CmdPreprocessor[src]

impl Preprocessor for IndexPreprocessor[src]

impl Preprocessor for LinkPreprocessor[src]

Loading content...