Markdown 2 Json

A functional library that takes a markdown body; and tries to create a JSON representation of the document.

Supports

• Headings
• Lists
• Paragraphs

Usage

Install:

• npm install @connected-web/md2json

const md2json = require('@connected-web/md2json')
const fs = require('fs')

const filename = 'README.md'
const md = fs.readFileSync(filename, 'utf8')
const json = md2json(filename, md)

console.log('Markdown to Json:', json)

Examples

• Example Output: examples/example-output.json
• Test Output: examples/test-output.json

Source only API

md2json(markdown)

Title and source API

md2json(title, markdown)

Options object API

md2json({
  title: 'README.md',
  markdown: '# Heading\n\nContent'
})

Option : title

The top level section of the JSON output.

Option : markdown | md

The text string representing the markdown to be converted to JSON

Tokens

const tokens = md2json.tokens('# Heading\n\nContent\n\n##Heading 1.1')
console.log(tokens)

Output:

[
  { "name": "h1", "text": "Heading" },
  { "name": "p", "text": "Content"},
  { "name": "h2", "text": "Heading 1.1"}
]

Approach

• Format parameters
• Render Markdown as HTML
• Create DOM from Markdown
• Create Tokens in the form: { name: el.tagName, text: el.text }
• Parse Tokens into Hierarchy
• Return JSON hierarchy

Licenses

Released under ISC.

Dependencies

• marked
• cheerio

Development tools

• mocha
• chai
• standard

Changelog

1.1.0

• Add .tokens(markdown) method to API

1.0.0

• First version ready for release
• Not perfect, but hopefully something people can work with