fastmatter
A fast frontmatter parser. Supports both string and stream inputs.
Usage
Given a document foo.md
containing YAML frontmatter and content:
---title: Hello, World!tags: [ foo, bar, baz ]---Lorem ipsum dolor sit amet consectetur adipisicing elit.
…we can parse this document as a string, via fastmatter(string)
:
const fastmatter = const fs = fs
…or as a stream, via fastmatter.stream([callback])
:
const fastmatter = const fs = const concat = fs
callback
is called with the frontmatter attributes
, while the document body
is simply passed through the stream. Also note that the this
context of callback
is the stream itself; this is useful if we want to change the flow of the stream depending on the parsed attributes
.
API
const fastmatter =
fastmatter(string)
Parses the string
and returns the parsed frontmatter attributes
and document body
.
fastmatter.stream([callback])
Calls callback
with the parsed frontmatter attributes
. The this
context of callback
is the stream itself. The document body
is passed through the stream.
Installation
Install via yarn:
$ yarn add fastmatter
Or npm:
$ npm install --save fastmatter