markdown-it-meta

Markdown-it Metadata as yaml for markdown documents

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
markdown-it-meta
0.0.17 years ago7 years agoMinified + gzip package size for markdown-it-meta in KB

Readme

Markdown-it-meta
Markdown-it plugin to add YAML metadata

Install

$ npm install markdown-it-meta --save

Use

const MarkdownIt = require('markdown-it')
const meta = require('markdown-it-meta')

// Make new instance
const md = new MarkdownIt()
// Add markdown-it-meta
md.use(meta)

const renderedDocument =  md.render('<md with YAML>')
return {
  document: renderedDocument,
  meta: md.meta
}

Features

Adds YAML to markdown documents to be used as meta data.
  • Make Strings
  • Make Arrays
  • Make Objects
  • All YAML is valid

Markdown

---
title: Welcome to Markdown-it-meta
keywords: markdown-it-meta
runs: 0
score: 0.0
demographics:
 - {name: 'unknown'}
---
## Hello World