Struct Reader 

pub struct Reader { /* private fields */ }

Markdown file reader.

Example

use glow::{Config, Reader};

let reader = Reader::new(Config::new().width(80));
let output = reader.read_file("README.md")?;
println!("{output}");

Implementations

impl Reader

pub fn new(config: Config) -> Self

Creates a new reader with the given configuration.

pub fn config(&self) -> &Config

Returns the reader configuration.

pub fn read_file<P: AsRef<Path>>(&self, path: P) -> Result<String>

Reads and renders a markdown file.

pub fn render_markdown(&self, markdown: &str) -> Result<String>

Renders markdown text using the configured renderer.

Trait Implementations

impl Debug for Reader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.