Struct quickmd::markdown::Renderer

pub struct Renderer {
    pub display_md_path: PathBuf,
    pub canonical_md_path: PathBuf,
}

Encapsulates a markdown file and provides an interface to turn its contents into HTML.

Fields

display_md_path: PathBuf

A short, user-friendly path to show in UI.

canonical_md_path: PathBuf

The canonicalized path to use in file operations.

Methods

impl Renderer

pub fn new(md_path: PathBuf) -> Self

Create a new renderer instance that wraps the given markdown file.

pub fn run(&self) -> Result<String, Error>

Turn the current contents of the markdown file into HTML.