extract-frontmatter 3.0.0

A library that allows a user to extract an arbitrary number of lines of 'front-matter' from the start of any string
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

# extract-frontmatter <!-- omit in toc -->

- [Overview](#overview)
    - [Versioning](#versioning)
    - [Repository information](#repository-information)
- [Usage](#usage)
    - [Extracting front-matter](#extracting-front-matter)
        - [Example](#example)
    - [Removing front-matter](#removing-front-matter)
        - [Example](#example-1)
    - [Split document](#split-document)
        - [Example](#example-2)
    - [Function overview](#function-overview)
        - [Selectors](#selectors)
        - [Modifiers](#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.

[![docs.io documentation](https://img.shields.io/badge/docs.io-Documentation-orange?style=for-the-badge)](https://docs.rs/extract-frontmatter)
[![crates.io version](https://img.shields.io/crates/v/extract-frontmatter?style=for-the-badge)](https://docs.rs/extract-frontmatter)
[![crates.io downloads](https://img.shields.io/crates/d/extract-frontmatter?style=for-the-badge)](https://crates.io/crates/extract-frontmatter)
[![Dependents](https://img.shields.io/librariesio/dependent-repos/cargo/extract-frontmatter?style=for-the-badge)](https://libraries.io/cargo/extract-frontmatter)
[![License](https://img.shields.io/crates/l/extract-frontmatter?style=for-the-badge)](https://gitlab.com/Kage-Yami/extract-frontmatter/-/blob/main/LICENSE)

### Versioning

This project follows [Semantic Versioning principals] starting with `v1.0.0`

[Semantic Versioning principals]: https://semver.org/

### Repository information

This repository is located on [GitLab.com].

[GitLab.com]: https://gitlab.com/isekai/libraries/rust/extract-frontmatter