Light

birhoff / mdast-util-to-bemjson Goto Github PK

View Code? Open in Web Editor NEW

1.0 3.0 0.0 86 KB

transforms mdast tree to bemjson tree

Home Page: https://github.com/bem-contrib/md-to-bemjson/tree/master/packages/mdast-util-to-bemjson

License: Other

JavaScript 100.00%

mdast bemjson converter

mdast-util-to-bemjson's Introduction

mdast-util-to-bemjson

Transforms MDAST tree to bemjson regarding to rules.

Requirements

Node.js 4+

Install

$ npm install mdast-util-to-bemjson

Usage

const unified = require('unified');
const markdown = require('remark-parse');
const toBemjson = require('mdast-util-to-bemjson');

const mdast = unified().use(markdown).parse('# Hello im _heading_');
const bjson = toBemjson(mdast);

console.log(JSON.stringify(bjson, null, 4));

Yields:

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

API

`toBemjson(mdastTree[, options])`

`options`

Function augment — callback called on every node.

`augment(bemNode):bemNode`. Important: Must return bemNode.

`bemNode` - representation of bem entity (block, elem, mod, props)

License

mdast-util-to-bemjson's People

Contributors

Stargazers

Watchers

mdast-util-to-bemjson's Issues

Properly describe rules in documentation

https://github.com/birhoff/mdast-util-to-bemjson/blob/master/doc/rules.md

Implements Scopes for blocks

На каждый узел маркдауна уметь генерировать как отдельный блок, так и элемент общего блока, переданного через опции

Support node.js version 4

Generate strict bemjson without nested bocks

we decide to generate simple bemjson here, and customize it with bem-xjst in remark-bemjson

Parse inline HTML

Распаршивать заинлайненный HTML в markdown

Do we need tags support

@tadatuta Do we need to support tags like this?
https://github.com/bem-contrib/markdown-bemjson/blob/master/rules/default.js#L6

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.