Trait mdbook::renderer::Renderer

source · 
pub trait Renderer {
    // Required methods
    fn name(&self) -> &str;
    fn render(&self, ctx: &RenderContext) -> Result<()>;
}
Expand description

An arbitrary mdbook backend.

Although it’s quite possible for you to import mdbook as a library and provide your own renderer, there are two main renderer implementations that 99% of users will ever use:

  • HtmlHandlebars - the built-in HTML renderer
  • CmdRenderer - a generic renderer which shells out to a program to do the actual rendering

Required Methods§

source

fn name(&self) -> &str

The Renderer’s name.

source

fn render(&self, ctx: &RenderContext) -> Result<()>

Invoke the Renderer, passing in all the necessary information for describing a book.

Implementors§