Struct mercurius::FrontMatter

pub struct FrontMatter {
    pub title: String,
    pub create_date: ReadableDate,
    pub last_update: Option<ReadableDate>,
    pub lang: Lang,
    pub description: Option<String>,
    pub tags: Option<Vec<String>>,
    pub status: Status,
    pub render: Render,
    pub banner: Banner,
}

The frontmatter in a Markdown file.

Note, mercurius only parses the frontmatter, it would never modify the parsing result itself. Functionalities below is implemented by another binary package named quatrain.

Fields

title: String

The title of the current file.

HTML Rendering

1. Title would be used in the <title> tag.
2. It would also be prepended as an <h1> at the front of the article.

create_date: ReadableDate

The create date of the file.

This should be the exact date the file was created, even empty.

last_update: Option<ReadableDate>

The last modified date of the file.

Formatting or rewriting should not be taken into account.

HTML Render

1. This field is now used to calculate the Outdate Info.

lang: Lang

Main language of the file.

This language should be the one used most in this file. Use the word Apple to refer that language, e.g., 林檎.

description: Option<String>

The description of the file.

Currently this field will not be used in any place. This is reserved for future usage, e.g., the <meta> tag.

tags: Option<Vec<String>>

Tagging the file.

Currently this field will not be used in any place. This is reserved for future usage, e.g., filtering by tags.

status: Status

The status of the file.

Currently this field will not be used in any place. This is reserved for future usage, e.g., conditional rendering or publishing.

render: Render

Control the rendering behavior.

banner: Banner

The banner of the file.

Trait Implementations

impl Clone for FrontMatter

fn clone(&self) -> FrontMatter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FrontMatter

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

Formats the value using the given formatter.

impl Default for FrontMatter

fn default() -> FrontMatter

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for FrontMatter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<FrontMatter> for FrontMatter

fn eq(&self, other: &FrontMatter) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FrontMatter) -> bool

This method tests for !=.

impl Serialize for FrontMatter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FrontMatter