Struct ReadmePreprocessor

pub struct ReadmePreprocessor;

A preprocessor for converting file name README.md to index.md since README.md is the de facto index file in markdown-based documentation.

Implementations

impl ReadmePreprocessor

pub fn new() -> Self

Create a new IndexPreprocessor.

Trait Implementations

impl Default for ReadmePreprocessor

fn default() -> ReadmePreprocessor

Returns the “default value” for a type.

impl Preprocessor for ReadmePreprocessor

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.