Need private packages and team management tools?Check out npm Teams »

markdown-it-front-matter

0.2.1 • Public • Published

markdown-it-front-matter

Plugin for processing front matter for markdown-it markdown parser.

npm

Valid Front Matter

Essentially, valid front matter is a fenced block:

  • Indicated by three or more dashes: ---
  • Opening and closing fences must be the same number of dash characters
  • Opening fence must begin on the first line of the markdown string/file
  • Opening fence must not be indented
---
valid-front-matter: true
---

The example above uses YAML but YAML is not required

(bring your own front matter parser)

Example

  • Front Matter is not rendered.
  • Any markup inside the block is passed to the required callback function.
const md = require('markdown-it')()
  .use(require('markdown-it-front-matter'), function(fm) {
    console.log(fm)
  });
 
let result = md.render('---\ntitle: This is the Title\n---\n# Heading\n----\nsome text');
 
// > title: This is the Title

Code heavily borrowed from markdown-it-container

Thank you:

puzrin

rlidwka

Install

npm i markdown-it-front-matter

DownloadsWeekly Downloads

13,646

Version

0.2.1

License

MIT

Unpacked Size

8.92 kB

Total Files

5

Last publish

Collaborators

  • avatar
  • avatar