Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

md-2-json

ajithr11.8kMIT2.0.0

Markdown to JSON convertor

md-to-json, markdown, markdown-to-json, md2json, md-2-json, mdjson, json, parser

readme

MARKDOWN-TO-JSON

A simple library to convert markdown content to JSON object.

Install

Install with npm:

$ npm install --save md-2-json

Usage

Simple content


var md2json = require('md-2-json');

md2json.parse('This is a markdown content');

/* output
{
    raw: "This is a markdown content\n"
}
*/

Multiline Content


var md2json = require('md-2-json');
var mdContent = `
# Heading 1

This is a para

- This is a list

## Heading 2

This is a para
`

md2json.parse(mdContent);

/* output
{
    "Heading 1": {
        raw: "This is a para\n - This is a list\n",
        "Heading 2": {
            raw: "This is a para\n"
        }
    }
}
*/

Converting JSON to MD string

The method toMd can be used to convert the JSON Object to Markdown string.


var md2json = require('md-2-json');
var json = {
    "Heading 1": {
        raw: "This is a para\n",
    }
}

md2json.toMd(json);

/* output
`
# Heading 1

This is a para

`
*/