@egoist/front-matter

Parse front-matter.

Stats

StarsIssuesVersionUpdatedCreatedSize
@egoist/front-matter
2531.0.03 years ago3 years agoMinified + gzip package size for @egoist/front-matter in KB

Readme

@egoist/front-matter

NPM version NPM downloads CircleCI donate chat

Why another front-matter library?

This library is only 200 bytes 🤯 It's ultra light-weight because it doesn't really parse the front-matter, you can choose your language of choice to parse it instead, e.g. Yaml or Toml or even simply JSON.parse.

Install

yarn add @egoist/front-matter

Usage

const frontMatter = require('@egoist/front-matter')

const { head, body } = frontMatter(`
---
title: Hell World
---

Hi there?
`)

assert(head === 'title: Hello World')
assert(body === '\nHi there?')

Parse head with js-yaml:

const yaml = require('js-yaml')
const frontMatter = require('@egoist/front-matter')

const { head, body } = frontMatter(str)
const parsedHead = yaml.safeLoad(head)

API

frontMatter(str, delimiter = '---')

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

@egoist/front-matter © egoist, Released under the MIT License.
Authored and maintained by egoist with help from contributors (list).

github.com/egoist · GitHub @egoist · Twitter @_egoistlily

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.