docmatter

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. `--- cso

Artistic-2.0 86 个版本

coffeescript data esnext extract extracting front front-matter frontmatter generator matter meta meta-data metadata node ssg static-site-generator template

主页

仓库

提交 Issue

安装

npm install docmatter

yarn add docmatter

pnpm add docmatter

bun add docmatter

README

docmatter

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.coffee is CoffeeScript source code with Require for modules
docmatter aliases docmatter/edition-esnext/index.js
docmatter/edition-esnext/index.js is 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

Benjamin Lupton — view contributions

Finances

Donors

License

Unless stated otherwise all works are:

and licensed under:

Artistic License 2.0

版本列表

4.7.0 2023-12-29

4.7.0-next.1703844277.18e3f340cf0adccb5f01e6dcadbe7480284918ee 2023-12-29

4.6.0-next.1703677215.bc692639868ea8682e6fd8f3160126d9a66ddcde 2023-12-27

4.5.0 2023-12-05

4.5.0-next.1701804448.fee62e804c2d23853edeaa52448bcf3224a99430 2023-12-05

4.4.0 2023-11-24

4.4.0-next.1700835930.75ef2234984791bf7f3052f98c74ec1c67f138ee 2023-11-24

4.3.0 2023-11-21

4.3.0-next.1700553553.bec792f4e3f198ea8245e8cd3262a6ea50527ec6 2023-11-21

4.2.0 2023-11-14

4.2.0-next.1699988010.63f3ef9c89a98a7bf87f3fac7a63fa5f64e9ec64 2023-11-14

4.1.0 2023-11-14

4.1.0-next.1699971255.6df09230bcd11b45b7b572dba1fb2d9cf49849a0 2023-11-14

4.0.0 2023-11-13

4.0.0-next.1699885751.1237bc573d03fa4354c44695db5d443bd94371c0 2023-11-13

3.23.0 2023-10-31

3.23.0-next.1698771905.b4a35bbfde890b8ead1f72499921377e1d79785a 2023-10-31

3.22.0 2021-07-29

3.22.0-next.1627591300.36f08640d8545dfcae6435d23e70576f05687450 2021-07-29

3.21.0 2021-07-28

3.21.0-next.1627498562.9b29393a4ca724e23e41e580d7d9d4c406051722 2021-07-28

3.20.0 2021-07-27

3.20.0-next.1627421138.389c34b229d76bf6305f00d966cf568c9534cdd3 2021-07-27

3.19.0 2020-10-28

3.19.0-next.1604239825.3b184813fe097953e1a023143ca4e139867c5d03 2020-11-01

3.19.0-next.1603927619.f7b3f1bbae9ebcddf9a5228515652776c128f500 2020-10-28

3.18.0 2020-09-04

3.18.0-next.1599398745.733daa79693e91f5114674763c1eba04eece9524 2020-09-06

3.18.0-next.1599392844.5466f1adf9a47bcf9765d9adee694b78202cf308 2020-09-06

3.18.0-next.1599210445.9bdd224b0a732c184d90a6cf8aa7e36e071b6f68 2020-09-04

3.17.0 2020-08-17

3.17.0-next.1597693332.67333e62e2eb0560737570aab612383c38061fc2 2020-08-17

3.16.0 2020-08-04

3.16.0-next.1596513104.994835df11b87557b009f950d112f710f3b537b9 2020-08-04

3.15.0 2020-07-21

3.15.0-next.1595352039.4c4fd24a25d8716ef6431da28b062f9ca28ffeb4 2020-07-21

3.14.0 2020-07-21

3.14.0-next.1595343611.0cefef16133ae8fd27d7f051914b482e5ff848df 2020-07-21

3.13.0 2020-07-03

3.13.0-next.1593752525.80a2eabda638fcab6de9ec09ffe2b8b4981db99c 2020-07-03

3.12.0 2020-07-03

3.12.0-next.1593747289.9c5c39a8854f92b0f2e1a9f228db4d4e7fd7eda5 2020-07-03

3.11.0 2020-06-25

3.11.0-next.1593051731.db01c0d6ab095c46f1c22c6db27428650bac6c16 2020-06-25

3.10.0 2020-06-21

3.10.0-next.1592738180.0c282b2c5681b77f09b4a3915c070c70f990bc06 2020-06-21

3.9.0-next.1592690219.849b01a30d553a38d881e01a43d36eaebe13fa34 2020-06-20

3.8.0 2020-06-19

3.8.0-next.1592606484.f9b2303d6d1b2e0fae8cb7da9318cf4e2eeba764 2020-06-19

3.7.0 2020-06-19

3.7.0-next.1592601744.d58cf688c2377d19b71fca20de37e897cfbda4e2 2020-06-19

3.6.0 2020-06-10

3.6.0-next.1591793139.057cdcd17f84aeda2dda70ff0cf33f9de66022f8 2020-06-10

3.5.0 2020-06-10

3.5.0-next.1591775943.32201cd951c70708b4859692cc25f662f72cafeb 2020-06-10

3.4.0 2020-05-21

3.4.0-next.1590071915.096bf5f7a330b8050d1195dbcf9e06d4da519a3d 2020-05-21

3.3.0 2020-05-21

3.3.0-next.1590035077.57aa43c004aa4b337575824b64c17b52f1f91a68 2020-05-21

3.2.0 2020-05-12

3.2.0-next.1589250034.f937b82699ef15ae1dd3e73714afffb278eabc40 2020-05-12

3.1.0 2020-05-04

3.1.0-next.1588595629.c0c1dfe38fc2cae59b84f4f558a94cc2ad09a940 2020-05-04

3.0.0 2020-03-25

3.0.0-next.1585175555.5f300a4a15c659e530c4192ba37000e51c9fb352 2020-03-25

2.5.0 2019-12-09

2.5.0-next.1585175411.598c51a57863e2c135fc1725f5fafd9799427a5c 2020-03-25

2.5.0-next.1575878849.f7fdd09d80374f072229ea7501ed5603ba650507 2019-12-09

2.4.0 2019-12-01

2.4.0-next.1575169329.565cf079386a943a57b50190e32efd7031dc4cc3 2019-12-01

2.3.0 2019-11-30

2.3.0-next.1575145624.98869fdc2b61d1c04663cb6bed084705278c40ba 2019-11-30

2.2.0 2019-11-30

2.2.0-next.1575138893.a98f04b03d65accc44db7f754a6318f818cdb8ae 2019-11-30

2.1.0 2019-11-18

2.1.0-next.1574650234.8e293103de06e10abe2b4d0c7a6d94d956a8128b 2019-11-25

2.1.0-next.1574628514.d41c3a59a4efb2c4d1968144e1a560a60ebe9c11 2019-11-24

2.1.0-next.1574046334.f7a7859000e7883ec31b5e129cd2dc364e1e4c00 2019-11-18

2.0.0 2019-11-18

2.0.0-next.1574045430.a4bba915a1a440e4e04b04d5f6edcf5992a31985 2019-11-18

1.2.0 2019-11-13

1.2.0-next.1573737990.af5d60195609b3a8900eca750b20c1622d64fef4 2019-11-14

1.2.0-next.1573631080.3e120ac49515443cd0e614474b3b6b339b7b510e 2019-11-13

1.2.0-next.1573623534.d5113f6ab0b32255af655666de3e8e6c9905d280 2019-11-13

1.1.0 2019-01-01

1.0.0 2018-06-10

docmatter

安装

README

docmatter

Usage

Install

npm

Editions

History

Backers

Code

Authors

Maintainers

Contributors

Finances

Sponsors

Donors

License

版本列表