0.0.1 • Published 4 years ago

@asleeppiano/markdown-it-frontmatter v0.0.1

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

markdown-it-frontmatter

Install

npm i @asleeppiano/markdown-it-frontmatter

Usage

import markdownIt from 'markdown-it'
import frontmatter from '@asleeppiano/markdown-it-frontmatter'

const md = markdown
  .use(frontmatter, null, (res) => {
    console.log(res) // { title: 'Title' }
  });
  md.render('---\ntitle: Title\n---\n# H1');

// The second parameter is for options
// {parser: 'toml'} or {parser: 'yaml'} - default
const md2 = markdown
  .use(frontmatter, {parser: 'toml'}, (res) => {
    console.log(res) // { title: 'Title' }
  });
  md.render('---\ntitle = Title\n---\n# H1');

Credits

  1. ParkSB/markdown-it-front-matter
  2. js-yaml
  3. iarna-toml