Markdown YAML metadata parser. Parse YAML metadata in a markdown document.
Install the latest version with npm or Yarn:
$ npm install markdown-yaml-metadata-parser
$ yarn add markdown-yaml-metadata-parser
In order to be parsed, metadata must be placed at the beginning of the markdown document between two triple dashes. Example:
---
title: Lorem ipsum dolor sit amet
author: Marcus Antonius
keywords: latin, ipsum
---
Vestibulum tortor quam, *feugiat vitae*, ultricies eget, tempor sit amet, ante.
Here's how to parse the metadata:
const metadataParser = require('markdown-yaml-metadata-parser');
// Assuming source is a string containing the markdown document
const source = '--- title: Lorem...';
// Parse source. Result is a two-property object
const result = metadataParser(source);
// The first property, 'metadata', is the object of parsed metadata. Example:
//
// {
// 'title': 'Lorem ipsum dolor sit amet',
// 'author': 'Marcus Antonius',
// 'keywords': 'latin, ipsum'
// };
result.metadata;
// The second property, 'content', is the document source without metadata. Example:
//
// Vestibulum tortor quam, *feugiat vitae*, ultricies eget, tempor sit amet, ante.
result.content;
Markdown YAML metadata parser is licensed under the MIT License. See the LICENSE
file for details.