unified

Project: landakram/remark-parse-yaml

Package: remark-parse-yaml@0.0.3

  1. Dependents: 12
  2. Parses yaml blocks into structured data
  1. remark 199
  2. markdown 137
  3. remark-plugin 77
  4. gfm 17

remark-parse-yaml

npm version Build Status

This remark plugin takes markdown with yaml frontmatter and parses the yaml into an object.

Usage

const unified = require('unified')
const markdown = require('remark-parse')
const frontmatter = require('remark-frontmatter')
const parseFrontmatter = require('remark-parse-yaml');

let processor = unified()
    .use(markdown)
    .use(frontmatter)
    .use(parseFrontmatter)

When the processor is run, yaml nodes will now have an additional key, parsedValue, attached to its data key.

Say that we have this markdown string:

---
metadata: this is metadata
tags:
    - one
    - two
---

# Heading 

When parsed, this will produce a yaml node with a data object that looks like this:

data: {
    parsedValue: {
        metadata: "this is metadata",
        tags: ["one", "two"]
    }
}