![\"Travis](\"https://img.shields.io/travis/com/bevry/docmatter/master.svg\")
\n![\"NPM](\"https://img.shields.io/npm/v/docmatter.svg\")
\n![\"NPM](\"https://img.shields.io/npm/dm/docmatter.svg\")
\n![\"Dependency](\"https://img.shields.io/david/bevry/docmatter.svg\")
\n![\"Dev](\"https://img.shields.io/david/dev/bevry/docmatter.svg\")
\n![\"Patreon](\"https://img.shields.io/badge/patreon-donate-yellow.svg\"){kind=icon}
\n![\"Flattr](\"https://img.shields.io/badge/flattr-donate-yellow.svg\"){kind=icon}
\n![\"Liberapay](\"https://img.shields.io/badge/liberapay-donate-yellow.svg\"){kind=icon}
\n![\"Buy](\"https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg\"){kind=icon}
\n![\"Open](\"https://img.shields.io/badge/open%20collective-donate-yellow.svg\"){kind=icon}
\n![\"crypto](\"https://img.shields.io/badge/crypto-donate-yellow.svg\"){kind=icon}
\n![\"PayPal](\"https://img.shields.io/badge/paypal-donate-yellow.svg\"){kind=icon}
\n![\"Wishlist](\"https://img.shields.io/badge/wishlist-donate-yellow.svg\"){kind=icon}
\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n\n\nnpm install --save docmatterrequire('docmatter')This package is published with the following editions:
\n\ndocmatter aliases docmatter/index.js which uses Editions to automatically select the correct edition for the consumers environmentdocmatter/source/index.coffee is coffeescript source code with require for modulesdocmatter/edition-esnext/index.js is coffeescript compiled for node.js with require for modulesdocmatter/edition-node-4/index.js is coffeescript compiled for node.js 4 with require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n\n\nnpm install --save docmatterrequire('docmatter')This package is published with the following editions:
\n\ndocmatter aliases docmatter/index.js which uses Editions to automatically select the correct edition for the consumers environmentdocmatter/source/index.coffee is coffeescript source code with require for modulesdocmatter/edition-esnext/index.js is coffeescript compiled for node.js with require for modulesdocmatter/edition-node-4/index.js is coffeescript compiled for node.js 4 with require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n\n\nnpm install --save docmatterrequire('docmatter')This package is published with the following editions:
\n\ndocmatter aliases docmatter/index.js which uses Editions to automatically select the correct edition for the consumers environmentdocmatter/source/index.coffee is coffeescript source code with require for modulesdocmatter/edition-esnext/index.js is coffeescript compiled for node.js with require for modulesdocmatter/edition-node-4/index.js is coffeescript compiled for node.js 4 with require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n\n\nnpm install --save docmatterrequire('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is coffeescript source code with require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is coffeescript compiled for node.js with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\nHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n\n\nnpm install --save docmatterrequire('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is coffeescript source code with require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is coffeescript compiled for node.js with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\nHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n\n\nnpm install --save docmatterrequire('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is coffeescript source code with require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is coffeescript compiled for node.js with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\nHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n\n\nnpm install --save docmatterrequire('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is coffeescript source code with require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is coffeescript compiled for node.js with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\nHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n\n\nnpm install --save docmatterrequire('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is coffeescript source code with require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is coffeescript compiled for node.js with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\nHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n\n\nnpm install --save docmatterrequire('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is coffeescript source code with require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is coffeescript compiled for node.js with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\nHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n\n\nnpm install --save docmatterrequire('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is coffeescript source code with require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is coffeescript compiled for node.js with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\nHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n![\"GitHub](\"https://img.shields.io/badge/github-donate-yellow.svg\"){kind=icon}
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n\n\nnpm install --save docmatterrequire('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is coffeescript source code with require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is coffeescript compiled for node.js with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\nHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n\n\nnpm install --save docmatterrequire('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is coffeescript source code with require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is coffeescript compiled for node.js with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\nHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter aliases docmatter/index.js which uses the Editions Autoloader to automatically select the correct edition for the consumer's environmentdocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n![\"Status](\"https://github.com/bevry/docmatter/workflows/bevry/badge.svg\"){kind=icon}
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n![\"ThanksDev](\"https://img.shields.io/badge/thanksdev-donate-yellow.svg\"){kind=icon}
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n![\"Discord](\"https://img.shields.io/discord/1147436445783560193?logo=discord&label=discord\")
\n![\"Twitch](\"https://img.shields.io/twitch/status/balupton?logo=twitch\")
\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nnpm install --save docmatterimport * as pkg from ('docmatter')const pkg = require('docmatter')This package is published with the following editions:
\n\ndocmatter/source/index.coffee is CoffeeScript source code with Require for modulesdocmatter aliases docmatter/edition-esnext/index.jsdocmatter/edition-esnext/index.js is CoffeeScript compiled for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## Install\n\n### [npm](https://npmjs.com \"npm is a package manager for javascript\")\n\n- Install: `npm install --save docmatter`\n- Import: `import * as pkg from ('docmatter')`\n- Require: `const pkg = require('docmatter')`\n\n### [Editions](https://editions.bevry.me \"Editions are the best way to produce and consume packages you care about.\")\n\nThis package is published with the following editions:\n- `docmatter/source/index.coffee` is [CoffeeScript](https://coffeescript.org \"CoffeeScript is a little language that compiles into JavaScript\") source code with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html \"Node/CJS Modules\") for modules\n- `docmatter` aliases `docmatter/edition-esnext/index.js`\n- `docmatter/edition-esnext/index.js` is [CoffeeScript](https://coffeescript.org \"CoffeeScript is a little language that compiles into JavaScript\") compiled for [Node.js](https://nodejs.org \"Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine\") 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html \"Node/CJS Modules\") for modules\n\n\n\n\n\n## History\n\n[Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/docmatter/blob/HEAD/HISTORY.md#files)\n\n\n\n\n\n## Backers\n\n### Code\n\n[Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/docmatter/blob/HEAD/CONTRIBUTING.md#files)\n\n#### Authors\n\n- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.\n\n#### Maintainers\n\n- [Benjamin Lupton](https://github.com/balupton) — Accelerating collaborative wisdom.\n\n#### Contributors\n\n- [Benjamin Lupton](https://github.com/balupton) — [view contributions](https://github.com/bevry/docmatter/commits?author=balupton \"View the GitHub contributions of Benjamin Lupton on repository bevry/docmatter\")\n\n### Finances\n\n\n\n\n\n\n\n\n\n\n#### Sponsors\n\n- [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher\n- [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.\n- [Codecov](https://codecov.io/) — Empower developers with tools to improve code quality and testing.\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.\n- [Syntax](https://syntax.fm) — Syntax Podcast\n\n#### Donors\n\n- [Andrew Nesbitt](https://nesbitt.io)\n- [Balsa](https://balsa.com)\n- [Chad](https://opencollective.com/chad8)\n- [Codecov](https://codecov.io/)\n- [entroniq](https://gitlab.com/entroniq)\n- [Jean-Luc Geering](https://github.com/jlgeering)\n- [Michael Duane Mooring](https://bevry.me)\n- [Mohammed Shah](https://github.com/smashah)\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Sentry](https://sentry.io)\n- [ServieJS](https://github.com/serviejs)\n- [Skunk Team](https://skunk.team)\n- [Syntax](https://syntax.fm)\n\n\n\n\n\n## License\n\nUnless stated otherwise all works are:\n\n- Copyright © [Benjamin Lupton](https://balupton.com)\n\nand licensed under:\n\n- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)\n\n\n","readmeFilename":"README.md","gitHead":"bc692639868ea8682e6fd8f3160126d9a66ddcde","_nodeVersion":"20.10.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-pU2KH7lDkST/Mjr0sDl8JQLSJ/itO2vuLve57mPEHdFplmzfYZWfqhPU196/wUKiAT9ktCKfpIB7vVKXIrSQ8A==","shasum":"c0d74b828101a6ceb148f599ac17ef980bce8d4a","tarball":"https://registry.npmjs.org/docmatter/-/docmatter-4.6.0-next.1703677215.bc692639868ea8682e6fd8f3160126d9a66ddcde.tgz","fileCount":8,"unpackedSize":32187,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIG4YVH5nnC/vQaL7J+50tvxmPAJTet6jpoKA0CV6SODsAiBFDqMxyViy69zVaoNeeSBmcKd25FuTZH4/40XT9JX7Iw=="}]},"_npmUser":{"name":"bevryme","email":"us@bevry.me"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docmatter_4.6.0-next.1703677215.bc692639868ea8682e6fd8f3160126d9a66ddcde_1703677216422_0.8852415465674504"},"_hasShrinkwrap":false},"4.7.0-next.1703844277.18e3f340cf0adccb5f01e6dcadbe7480284918ee":{"name":"docmatter","version":"4.7.0-next.1703844277.18e3f340cf0adccb5f01e6dcadbe7480284918ee","license":"Artistic-2.0","description":"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","homepage":"https://github.com/bevry/docmatter","funding":"https://bevry.me/fund","repository":{"type":"git","url":"git+https://github.com/bevry/docmatter.git"},"bugs":{"url":"https://github.com/bevry/docmatter/issues"},"keywords":["coffeescript","data","esnext","extract","extracting","front","front-matter","frontmatter","generator","matter","meta","meta-data","metadata","node","ssg","static-site-generator","template"],"badges":{"list":["githubworkflow","npmversion","npmdownloads","---","githubsponsors","thanksdev","patreon","liberapay","buymeacoffee","opencollective","crypto","paypal","---","discord","twitch"],"config":{"githubWorkflow":"bevry","githubSponsorsUsername":"balupton","thanksdevGithubUsername":"bevry","buymeacoffeeUsername":"balupton","cryptoURL":"https://bevry.me/crypto","flattrUsername":"balupton","liberapayUsername":"bevry","opencollectiveUsername":"bevry","patreonUsername":"bevry","paypalURL":"https://bevry.me/paypal","wishlistURL":"https://bevry.me/wishlist","discordServerID":"1147436445783560193","discordServerInvite":"nQuXddV7VP","twitchUsername":"balupton","githubUsername":"bevry","githubRepository":"docmatter","githubSlug":"bevry/docmatter","npmPackageName":"docmatter"}},"author":{"name":"Benjamin Lupton","email":"b@lupton.cc","url":"https://balupton.com"},"authors":["Benjamin Lupton \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## Install\n\n### [npm](https://npmjs.com \"npm is a package manager for javascript\")\n\n- Install: `npm install --save docmatter`\n- Import: `import * as pkg from ('docmatter')`\n- Require: `const pkg = require('docmatter')`\n\n### [Editions](https://editions.bevry.me \"Editions are the best way to produce and consume packages you care about.\")\n\nThis package is published with the following editions:\n- `docmatter/source/index.coffee` is [CoffeeScript](https://coffeescript.org \"CoffeeScript is a little language that compiles into JavaScript\") source code with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html \"Node/CJS Modules\") for modules\n- `docmatter` aliases `docmatter/edition-esnext/index.js`\n- `docmatter/edition-esnext/index.js` is [CoffeeScript](https://coffeescript.org \"CoffeeScript is a little language that compiles into JavaScript\") compiled for [Node.js](https://nodejs.org \"Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine\") 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html \"Node/CJS Modules\") for modules\n\n\n\n\n\n## History\n\n[Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/docmatter/blob/HEAD/HISTORY.md#files)\n\n\n\n\n\n## Backers\n\n### Code\n\n[Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/docmatter/blob/HEAD/CONTRIBUTING.md#files)\n\n#### Authors\n\n- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.\n\n#### Maintainers\n\n- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.\n\n#### Contributors\n\n- [Benjamin Lupton](https://github.com/balupton) — [view contributions](https://github.com/bevry/docmatter/commits?author=balupton \"View the GitHub contributions of Benjamin Lupton on repository bevry/docmatter\")\n\n### Finances\n\n\n\n\n\n\n\n\n\n\n#### Sponsors\n\n- [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher\n- [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.\n- [Codecov](https://codecov.io) — Empower developers with tools to improve code quality and testing.\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.\n- [Syntax](https://syntax.fm) — Syntax Podcast\n\n#### Donors\n\n- [Andrew Nesbitt](https://nesbitt.io)\n- [Armen Mkrtchian](https://mogoni.dev)\n- [Balsa](https://balsa.com)\n- [Chad](https://opencollective.com/chad8)\n- [Codecov](https://codecov.io)\n- [dr.dimitru](https://veliovgroup.com)\n- [Elliott Ditman](https://elliottditman.com)\n- [entroniq](https://gitlab.com/entroniq)\n- [GitHub](https://github.com/about)\n- [Hunter Beast](https://cryptoquick.com)\n- [Jean-Luc Geering](https://github.com/jlgeering)\n- [Michael Duane Mooring](https://mdm.cc)\n- [Michael Harry Scepaniak](https://michaelscepaniak.com)\n- [Mohammed Shah](https://github.com/smashah)\n- [Mr. Henry](https://mrhenry.be)\n- [Nermal](https://arjunaditya.vercel.app)\n- [Pleo](https://pleo.io)\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Robert de Forest](https://github.com/rdeforest)\n- [Sentry](https://sentry.io)\n- [ServieJS](https://github.com/serviejs)\n- [Skunk Team](https://skunk.team)\n- [Syntax](https://syntax.fm)\n- [WriterJohnBuck](https://github.com/WriterJohnBuck)\n\n\n\n\n\n## License\n\nUnless stated otherwise all works are:\n\n- Copyright © [Benjamin Lupton](https://balupton.com)\n\nand licensed under:\n\n- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)\n\n\n","readmeFilename":"README.md","gitHead":"18e3f340cf0adccb5f01e6dcadbe7480284918ee","_nodeVersion":"20.10.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-N/te3LX5fypqBH9/S8pD2v0uk5B1KBrqzT9ew8F0bREG2f1YPzafMpYkgQYaBBEsUp/zsU8H96vbElJhYV5yuw==","shasum":"4228b9199a4f9f8943e241c1c159aefe033a34b8","tarball":"https://registry.npmjs.org/docmatter/-/docmatter-4.7.0-next.1703844277.18e3f340cf0adccb5f01e6dcadbe7480284918ee.tgz","fileCount":8,"unpackedSize":33562,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFPOavqohRhZB7EJQfOqT/EZNMjygNZHAhKj55BfG320AiAVgvaZDLTqvbhaCpABnR+Z9KPX7AaIUD0OcrL8+mCuIg=="}]},"_npmUser":{"name":"bevryme","email":"us@bevry.me"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docmatter_4.7.0-next.1703844277.18e3f340cf0adccb5f01e6dcadbe7480284918ee_1703844333500_0.8792741436776028"},"_hasShrinkwrap":false},"4.7.0":{"name":"docmatter","version":"4.7.0","license":"Artistic-2.0","description":"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","homepage":"https://github.com/bevry/docmatter","funding":"https://bevry.me/fund","repository":{"type":"git","url":"git+https://github.com/bevry/docmatter.git"},"bugs":{"url":"https://github.com/bevry/docmatter/issues"},"keywords":["coffeescript","data","esnext","extract","extracting","front","front-matter","frontmatter","generator","matter","meta","meta-data","metadata","node","ssg","static-site-generator","template"],"badges":{"list":["githubworkflow","npmversion","npmdownloads","---","githubsponsors","thanksdev","patreon","liberapay","buymeacoffee","opencollective","crypto","paypal","---","discord","twitch"],"config":{"githubWorkflow":"bevry","githubSponsorsUsername":"balupton","thanksdevGithubUsername":"bevry","buymeacoffeeUsername":"balupton","cryptoURL":"https://bevry.me/crypto","flattrUsername":"balupton","liberapayUsername":"bevry","opencollectiveUsername":"bevry","patreonUsername":"bevry","paypalURL":"https://bevry.me/paypal","wishlistURL":"https://bevry.me/wishlist","discordServerID":"1147436445783560193","discordServerInvite":"nQuXddV7VP","twitchUsername":"balupton","githubUsername":"bevry","githubRepository":"docmatter","githubSlug":"bevry/docmatter","npmPackageName":"docmatter"}},"author":{"name":"Benjamin Lupton","email":"b@lupton.cc","url":"https://balupton.com"},"authors":["Benjamin Lupton \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBattle 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.\n\n\n\n\n## Usage\n\ndocmatter is designed to be functional yet minimal, default parser as well as parsing of the headers are handled by you\n\n``` js\nconst docmatter = require('docmatter')\nconst yamljs = require('yamljs')\n\nfunction parse (input) {\n const matter = docmatter(input)\n\n // if no front matter: {content}\n if (!matter.header) return { content: matter.content.trim() }\n\n // if front matter: {delimiter, parser, header, body, content}\n let data = null\n switch (matter.parser) {\n case 'json':\n if (matter.header[0] === '{' && matter.header[matter.header.length - 1] === '}') {\n data = JSON.parse(matter.header)\n }\n else {\n data = JSON.parse(`{${matter.header}}`)\n }\n break;\n\n\n case 'yaml':\n default:\n data = yamljs.parse(\n matter.header.replace(/\\t/g, ' ') // YAML doesn't support tabs that well\n )\n break;\n }\n return { data, content: matter.body.trim() }\n}\n\n\n// no content and only front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n`))\n// => { data: { title: 'Hello World' }, content: '' }\n\n\n// markdown content with default front matter\nconsole.log(parse(`\n---\ntitle: Hello World\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with json front matter\nconsole.log(parse(`\n--- json\n\"title\": \"Hello World\"\n---\n\n**hello world**\n`))\n// => { data: { title: 'Hello World' }, content: '**hello world**' }\n\n\n// markdown content with no front matter\nconsole.log(parse(`\n**hello world**\n`))\n// => { content: '**hello world**' }\n\n\n// javascript content with default front matter\nconsole.log(parse(`\n/***\nminify: true\n***/\n\nalert('Hello World')\n`))\n// => { data: { minify: true }, content: 'alert(\\'Hello World\\')' }\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## Install\n\n### [npm](https://npmjs.com \"npm is a package manager for javascript\")\n\n- Install: `npm install --save docmatter`\n- Import: `import * as pkg from ('docmatter')`\n- Require: `const pkg = require('docmatter')`\n\n### [Editions](https://editions.bevry.me \"Editions are the best way to produce and consume packages you care about.\")\n\nThis package is published with the following editions:\n- `docmatter/source/index.coffee` is [CoffeeScript](https://coffeescript.org \"CoffeeScript is a little language that compiles into JavaScript\") source code with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html \"Node/CJS Modules\") for modules\n- `docmatter` aliases `docmatter/edition-esnext/index.js`\n- `docmatter/edition-esnext/index.js` is [CoffeeScript](https://coffeescript.org \"CoffeeScript is a little language that compiles into JavaScript\") compiled for [Node.js](https://nodejs.org \"Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine\") 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html \"Node/CJS Modules\") for modules\n\n\n\n\n\n## History\n\n[Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/docmatter/blob/HEAD/HISTORY.md#files)\n\n\n\n\n\n## Backers\n\n### Code\n\n[Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/docmatter/blob/HEAD/CONTRIBUTING.md#files)\n\n#### Authors\n\n- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.\n\n#### Maintainers\n\n- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.\n\n#### Contributors\n\n- [Benjamin Lupton](https://github.com/balupton) — [view contributions](https://github.com/bevry/docmatter/commits?author=balupton \"View the GitHub contributions of Benjamin Lupton on repository bevry/docmatter\")\n\n### Finances\n\n\n\n\n\n\n\n\n\n\n#### Sponsors\n\n- [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher\n- [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.\n- [Codecov](https://codecov.io) — Empower developers with tools to improve code quality and testing.\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.\n- [Syntax](https://syntax.fm) — Syntax Podcast\n\n#### Donors\n\n- [Andrew Nesbitt](https://nesbitt.io)\n- [Armen Mkrtchian](https://mogoni.dev)\n- [Balsa](https://balsa.com)\n- [Chad](https://opencollective.com/chad8)\n- [Codecov](https://codecov.io)\n- [dr.dimitru](https://veliovgroup.com)\n- [Elliott Ditman](https://elliottditman.com)\n- [entroniq](https://gitlab.com/entroniq)\n- [GitHub](https://github.com/about)\n- [Hunter Beast](https://cryptoquick.com)\n- [Jean-Luc Geering](https://github.com/jlgeering)\n- [Michael Duane Mooring](https://mdm.cc)\n- [Michael Harry Scepaniak](https://michaelscepaniak.com)\n- [Mohammed Shah](https://github.com/smashah)\n- [Mr. Henry](https://mrhenry.be)\n- [Nermal](https://arjunaditya.vercel.app)\n- [Pleo](https://pleo.io)\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Robert de Forest](https://github.com/rdeforest)\n- [Sentry](https://sentry.io)\n- [ServieJS](https://github.com/serviejs)\n- [Skunk Team](https://skunk.team)\n- [Syntax](https://syntax.fm)\n- [WriterJohnBuck](https://github.com/WriterJohnBuck)\n\n\n\n\n\n## License\n\nUnless stated otherwise all works are:\n\n- Copyright © [Benjamin Lupton](https://balupton.com)\n\nand licensed under:\n\n- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)\n\n\n","readmeFilename":"README.md"}