frontmatter

Types

Extracted

pub type Extracted {
  Extracted(frontmatter: Option(String), content: String)
}

Constructors

Extracted(frontmatter: Option(String), content: String)

Functions

extract

</>

pub fn extract(input: String) -> Extracted

Extract frontmatter from a text document. That is, some content a the very start of the document that begins and ends with a --- line.

Here’s an example showing what a document with frontmatter could look like.

---
# Here is some frontmatter.
# It can contain any format, but in this example TOML is used.
title = "My document"
---
# Hello!

Here is the rest of the document. It can also use any format, but in this
example _markdown_ is used.

Both UNIX and Windows style line endings are supported.