Struct FlatPage

pub struct FlatPage<E = ()> {
    pub title: String,
    pub description: Option<String>,
    pub body: String,
    pub extra: E,
}

Flat page The generic parameter E is used to define extra frontmatter fields

Fields

title: String

Title - for html title tag, og:title, etc

description: Option<String>

Description - for html meta description, og:description, etc

body: String

Raw markdown version of the body

extra: E

Extra frontmatter fields (except of title and description)

Implementations

impl<E: DeserializeOwned> FlatPage<E>

pub fn by_url(root: impl Into<PathBuf>, url: &str) -> Result<Option<Self>>

Returns a page by its url

pub fn by_path(path: impl AsRef<Path>) -> Result<Option<Self>>

Returns a page by its file path

pub fn html(&self) -> String

FlatPage::body rendered to html

Trait Implementations

impl<E: Debug> Debug for FlatPage<E>

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

Formats the value using the given formatter.

impl From<FlatPage> for FlatPageMeta

fn from(p: FlatPage) -> Self

Converts to this type from the input type.