Wondering what’s next for npm?Check out our public roadmap! »

    docmatter

    3.19.0 • Public • Published

    docmatter

    Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

    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 with Require for modules

    History

    Discover the release history by heading on over to the HISTORY.md file.

    Contribute

    Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

    Backers

    Maintainers

    These amazing people are maintaining this project:

    Sponsors

    No sponsors yet! Will you be the first?

    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

    Contributors

    These amazing people have contributed code to this project:

    Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

    License

    Unless stated otherwise all works are:

    and licensed under:

    Install

    npm i docmatter

    DownloadsWeekly Downloads

    116

    Version

    3.19.0

    License

    MIT

    Unpacked Size

    26 kB

    Total Files

    8

    Last publish

    Collaborators

    • avatar