extract-frontmatter

• Overview
  • Versioning
  • Repository information
• Usage
  • Extracting front-matter
    • Example
  • Removing front-matter
    • Example
  • Split document
    • Example
  • Function overview
    • Selectors
    • Modifiers

Overview

A Rust library that allows a user to extract an arbitrary number of lines of "front-matter" from the start of any multiline string.

Note that absolutely no parsing of extracted front-matter is performed; this is designed to output its results for another library to then parse.

Versioning

This project follows Semantic Versioning principals starting with v1.0.0

Repository information

This repository is located on GitLab.com.

Usage

Input:

root:
  child1: true
  child2: two
---

# Example

This is an example Markdown file.

Extracting front-matter

1. Instantiate an instance of Extractor
2. Call a selector method on it
3. Call zero or more modifier methods on it
4. Call:
   • extract (for a String), or
   • collect (for a Vec<&str>)

Example

Code:

use extract_frontmatter::Extractor;

let mut extractor = Extractor::new(input);
extractor.select_by_terminator("---");

let output: String = extractor.extract();

Output:

root:
  child1: true
  child2: two

Removing front-matter

1. Instantiate an instance of Extractor
2. Call a selector method on it
3. Call remove on it

Example

Code:

use extract_frontmatter::Extractor;

let mut extractor = Extractor::new(input);
extractor.select_by_terminator("---");

let output: &str = extractor.remove().trim();

Output:

# Example

This is an example Markdown file.

Split document

1. Instantiate an instance of Extractor
2. Call a selector method on it
3. Call zero or more modifier methods on it
4. Call split on it

Example

Code:

use extract_frontmatter::Extractor;

let mut extractor = Extractor::new(input);
extractor.select_by_terminator("---");

let (front_matter, document): (Vec<&str>, &str) = extractor.split();

let front_matter = front_matter.join("\n");
let document = document.trim();

Front matter:

root:
  child1: true
  child2: two

Document:

# Example

This is an example Markdown file.

Function overview

Selectors

Modifiers