matter 0.1.0-alpha4

Universal frontmatter parser.
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
42

# Matter

[![CI Status
Badge](https://gitlab.com/secretfader/matter/badges/master/pipeline.svg)](https://gitlab.com/secretfader/matter)
[![Crates.io Downloads Badge](https://img.shields.io/crates/d/matter)](https://crates.io/crates/matter)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![Made by Fader](https://img.shields.io/badge/made_by-Fader-purple.svg)](https://www.secretfader.com)

A universal frontmatter parser and extractor, written in Rust.

## Installation

By default, matter is installed with support for TOML, YAML, and JSON
frontmatter formats. However, you can override the defaults and install support
for one specific format like so:

`matter = { version = "0.1.0-alpha3", features = ["toml"] }`

## Usage

Once installed, you'll notice that Matter exports only a handful of functions.
This is because it does most of the work for you. It also attempts to operate
with minimal overhead, by only allocating as necessary.

```rust
let input = std::fs::read_to_string("./path/to/content.md").unwrap();
let Some((matter, content)) = matter::extract(&input).unwrap();
```

See [the docs](https://docs.rs/matter) for more examples.

## CLI

Matter is also distributed as a command line application. Install (`cargo
install matter --version 0.1.0-alpha3`) and run to inspect any file's frontmatter:

`matter path/to/content.md`

## License

Copyright 2018 Nicholas Young, All rights reserved. Released under
a [3-Clause BSD License](LICENSE).