Struct mdbook::preprocess::LinkPreprocessor

pub struct LinkPreprocessor;

A preprocessor for expanding helpers in a chapter. Supported helpers are:

• {{# include}} - Insert an external file of any type. Include the whole file, only particular . lines, or only between the specified anchors.
• {{# rustdoc_include}} - Insert an external Rust file, showing the particular lines . specified or the lines between specified anchors, and include the rest of the file behind #. This hides the lines from initial display but shows them when the reader expands the code block and provides them to Rustdoc for testing.
• {{# playpen}} - Insert runnable Rust files

Methods

impl LinkPreprocessor

pub fn new() -> Self

Create a new LinkPreprocessor.

Trait Implementations

impl Default for LinkPreprocessor

fn default() -> LinkPreprocessor

Returns the "default value" for a type.

impl Preprocessor for LinkPreprocessor

fn name(&self) -> &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) -> bool

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