bevrydocmatter
Battle tested SSG front matter parser. Extracted from DocPad. Delimiter lines have 3+ of the same character (such as /*** and ***/) allowing front matters to work with the syntax highlighting of your code editor. Supports custom parsers, e.g. --- cson. Parsers are handled externally.
Usage
docmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you
const docmatter = require('docmatter')
const yamljs = require('yamljs')
function parse (input) {
const matter = docmatter(input)
// if no front matter: {content}
if (!matter.header) return { content: matter.content.trim() }
// if front matter: {delimiter, parser, header, body, content}
let data = null
switch (matter.parser) {
case 'json':
if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {
data = JSON.parse(matter.header)
}
else {
data = JSON.parse(`{${matter.header}}`)
}
break;
case 'yaml':
default:
data = yamljs.parse(
matter.header.replace(/\t/g, ' ') // YAML doesn't support tabs that well
)
break;
}
return { data, content: matter.body.trim() }
}
// no content and only front matter
console.log(parse(`
---
title: Hello World
---
`))
// => { data: { title: 'Hello World' }, content: '' }
// markdown content with default front matter
console.log(parse(`
---
title: Hello World
---
**hello world**
`))
// => { data: { title: 'Hello World' }, content: '**hello world**' }
// markdown content with json front matter
console.log(parse(`
--- json
"title": "Hello World"
---
**hello world**
`))
// => { data: { title: 'Hello World' }, content: '**hello world**' }
// markdown content with no front matter
console.log(parse(`
**hello world**
`))
// => { content: '**hello world**' }
// javascript content with default front matter
console.log(parse(`
/***
minify: true
***/
alert('Hello World')
`))
// => { data: { minify: true }, content: 'alert(\'Hello World\')' }Install
npm
- Install:
npm install --save docmatter - Import:
import * as pkg from ('docmatter') - Require:
const pkg = require('docmatter')
Editions
This package is published with the following editions:
docmatter/source/index.coffeeis CoffeeScript source code with Require for modulesdocmatteraliasesdocmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.jsis CoffeeScript compiled for Node.js 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
History
Discover the release history by heading on over to the HISTORY.md file.
Backers
Code
Discover how to contribute via the CONTRIBUTING.md file.
Authors
- Benjamin Lupton — Accelerating collaborative wisdom.
Maintainers
- Benjamin Lupton — Accelerating collaborative wisdom.
Contributors
Finances
Sponsors
- Andrew Nesbitt — Software engineer and researcher
- Balsa — We're Balsa, and we're building tools for builders.
- Codecov — Empower developers with tools to improve code quality and testing.
- Poonacha Medappa
- Rob Morris
- Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
- Syntax — Syntax Podcast
Donors
- Andrew Nesbitt
- Armen Mkrtchian
- Balsa
- Chad
- Codecov
- dr.dimitru
- Elliott Ditman
- entroniq
- GitHub
- Hunter Beast
- Jean-Luc Geering
- Michael Duane Mooring
- Michael Harry Scepaniak
- Mohammed Shah
- Mr. Henry
- Nermal
- Pleo
- Poonacha Medappa
- Rob Morris
- Robert de Forest
- Sentry
- ServieJS
- Skunk Team
- Syntax
- WriterJohnBuck
License
Unless stated otherwise all works are:
- Copyright © Benjamin Lupton
and licensed under: