mdjson
Transform markdown to an object where headings are keys
Last updated 5 years ago by yoshuawuyts .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install mdjson 
SYNC missed versions from official npm registry.

mdjson

NPM version build status Test coverage Downloads js-standard-style

Transform markdown to an object where headings are keys.

Installation

$ npm install mdjson

Usage

const mdjson = require('mdjson')

mdjson(`
  This part (before any headers) is ignored. Feel free
  to use this section for commentary on the file's purpose,
  if you wish.

  ## my heading
  oh wow, amazing

  ## another heading
  gorgeous copy, stunning
`)
// => {
//  'my heading': {
//    raw: 'oh wow, amazing',
//    html: '<p>oh wow, amazing</p>'
//  },
//  'another heading': {
//    raw: 'gorgeous copy, stunning',
//    html: '<p>gorgeous copy, stunning</p>'
//  }
//}

Why?

Writing copy in markdown is more pleasant than writing it inline in html or JS. This module allows you to separate copy from markup on a page per page basis.

See Also

  • newspeak - Natural language localization
  • ndjson - newline delimited json parser, not to be confused with this markdown module

License

MIT

Current Tags

  • 2.0.1                                ...           latest (5 years ago)

5 Versions

  • 2.0.1                                ...           5 years ago
  • 2.0.0                                ...           5 years ago
  • 1.1.1                                ...           5 years ago
  • 1.1.0                                ...           6 years ago
  • 1.0.0                                ...           6 years ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 2
Last Month 3
Dependencies (2)
Dev Dependencies (3)
Dependents (2)

Copyright 2014 - 2016 © taobao.org |