Struct blarf::article::Article

pub struct Article {
    pub markdown: String,
    pub slug: String,
    pub title: String,
}

Data container for a single article

Fields

markdown: String

Raw markdown of article

slug: String

Short name of the article, appropriate for generating hyperlinks

Example:

1-my-first-post

title: String

Title of the article, appropriate for display

Example:

My First Post

Methods

impl Article

pub fn new(markdown: String, slug: String) -> Article

Constructor for Article

Note that this will attempt to write the title field of the Article using Article::get_title, defaulting to an empty string if none is found.

Example

let markdown = String::from("# My first post\nHello world!");
let slug = "1-my-first-post"
let article = Article::new(markdown, slug);

pub fn render(&self, css: &str, footer: &str) -> String

Render the main template to html

Example

let html = article.render("styles.css", "<p>copyright 2019</p>");

pub fn render_footer(
    index: usize,
    articles: &[Article],
    email: Option<&str>
) -> String

Render a footer, with navigation controls based on position in list of articles

pub fn get_title(markdown: &str) -> Option<&str>

Parse title from markdown

Returns text of first top-level heading (like # My first post), or None