Struct GithubAuthorsPreprocessor

pub struct GithubAuthorsPreprocessor;

Implementations

impl GithubAuthorsPreprocessor

A preprocessor for expanding “authors” helper.

NOTE: rather than expanding, this preprocessor adds a stylized Contributor section to the bottom of the Chapter, irrespective of where these author helpers are found in the raw markdown file.

Supported helpers are:

• {{#author <github-username>}} - Adds a single author to the Contributor section
• {{#authors <comma-separated-username-list>}} - Adds listed authors to the Contributor section.

pub fn new() -> Self

Create a new GithubAuthorsPreprocessor.

Trait Implementations

impl Default for GithubAuthorsPreprocessor

fn default() -> GithubAuthorsPreprocessor

Returns the “default value” for a type.

impl Preprocessor for GithubAuthorsPreprocessor

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.