Neighborly Package Megalodon

    @egoist/front-matter

    1.0.0 • Public • Published

    @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

    Keywords

    none

    Install

    npm i @egoist/front-matter

    DownloadsWeekly Downloads

    3

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    5.86 kB

    Total Files

    5

    Last publish

    Collaborators

    • egoist