Remark-bemjson NPM

remark-bemjson

Compile markdown to BEMJSON with remark.

Requirements

Node.js 8+

Install

$ npm install remark-bemjson

Usage

const remark = require('remark');
const bemjson = require('remark-bemjson');

const file = remark().use(bemjson).processSync('# Hello im _heading_');

console.log(String(file));

Yields:

{
  "block": "documentation",
  "content": {
    "block": "heading",
    "mods": {
      "level": 1
    },
    "content": [
      "Hello im ",
      {
        "block": "emphasis",
        "content": "heading"
      }
    ]
  }
}

API

`remark.use(bemjson[, options])`

`options`

string exportType - determinate how to export bemjson. Default: `commonJS`

Value	Description
`commonJS`	Exports to CJS.
`modules`	Exports to ES6 modules. Optional combines with `exportName`.
`umd`	Exports to UMD with umd package. Requires exportName.
`YModules`	Exports to YModules. Requires exportName.
`no export`	Don't do any export. Just plain `JSON.stringify`.