Struct futhorc::parser::Parser

pub struct Parser<'a> { /* private fields */ }

Parses Post objects from source files.

Implementations

impl<'a> Parser<'a>

pub fn new( index_url: &'a Url, posts_url: &'a Url, posts_directory: &'a Path ) -> Parser<'a>

Constructs a new parser. See fields on Parser for argument descriptions.

pub fn parse_posts(&self, source_directory: &Path) -> Result<Vec<Post>>

Searches a provided source_directory for post files (extension = .md) and returns a list of Post objects sorted by date (most recent first). Each post file must be structured as follows:

1. Initial frontmatter fence (---)
2. YAML frontmatter with fields Title, Date, and optionally Tags
3. Terminal frontmatter fence (---)
4. Post body

For example:

---
Title: Hello, world!
Date: 2021-04-16
Tags: [greet]
---
# Hello

World