# mdast-util-to-bemjson

> Converts mdast tree to bemjson tree

Latest version **1.0.3** (published 2019-06-20) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install mdast-util-to-bemjson
pnpm add mdast-util-to-bemjson
yarn add mdast-util-to-bemjson
bun add mdast-util-to-bemjson
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-06-20 |
| First published | 2017-03-13 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 8 |
| Dependencies | 6 |
| Unpacked size | 35.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Konstantin Gladkikh |
| Maintainers | birhoff, qfox |
| Keywords | mdast, bemjson |

## Links

- npm: https://www.npmjs.com/package/mdast-util-to-bemjson
- Repository: https://github.com/bem-contrib/md-to-bemjson
- Homepage: https://github.com/bem-contrib/md-to-bemjson/packages/mdast-util-to-bemjson#readme
- Issues: https://github.com/bem-contrib/md-to-bemjson/issues?q=label%3Apkg%3Amdast-util-to-bemjson
- npm.io page: https://npm.io/package/mdast-util-to-bemjson

## Dependencies (6)

- [detab](https://npm.io/package/detab.md) ^2.0.0
- [lodash.omit](https://npm.io/package/lodash.omit.md) ^4.5.0
- [normalize-uri](https://npm.io/package/normalize-uri.md) ^1.1.0
- [lodash.clonedeep](https://npm.io/package/lodash.clonedeep.md) ^4.5.0
- [lodash.defaultsdeep](https://npm.io/package/lodash.defaultsdeep.md) ^4.6.0
- [mdast-util-definitions](https://npm.io/package/mdast-util-definitions.md) ^1.2.2

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.3 (latest) — 2019-06-20
- 0.5.0-canary.328750a (canary) — 2018-06-28
- 1.0.2 — 2019-06-20
- 1.0.1 — 2019-02-25
- 1.0.0 — 2018-10-23
- 0.6.1 — 2018-08-16
- 0.5.0 — 2018-06-29
- 0.5.0-canary.cc1c85a — 2018-06-27
- 0.4.0 — 2017-10-06
- 0.4.0-alpha.a5125ef3 — 2017-10-06
- 0.3.0 — 2017-10-01
- 0.2.1 — 2017-03-31
- 0.2.0 — 2017-03-31
- 0.1.1 — 2017-03-15
- 0.1.0 — 2017-03-15
- … 1 more at https://npm.io/package/mdast-util-to-bemjson/versions

## README

# mdast-util-to-bemjson
Transforms MDAST tree to bemjson regarding to [rules](/doc/rules.md).

[![NPM Status][npm-img]][npm]
[![Travis Status][test-img]][travis]
[![Coverage Status][coverage-img]][coveralls]
[![Dependency Status][dependency-img]][david]
[![Greenkeeper badge][greenkeeper-img]][greenkeeper]

[npm]:            https://www.npmjs.org/package/mdast-util-to-bemjson
[npm-img]:        https://img.shields.io/npm/v/mdast-util-to-bemjson.svg

[travis]:         https://travis-ci.org/birhoff/mdast-util-to-bemjson
[test-img]:       https://img.shields.io/travis/birhoff/mdast-util-to-bemjson.svg?label=tests

[coveralls]:      https://coveralls.io/r/birhoff/mdast-util-to-bemjson
[coverage-img]:   https://img.shields.io/coveralls/birhoff/mdast-util-to-bemjson.svg

[david]:          https://david-dm.org/birhoff/mdast-util-to-bemjson
[dependency-img]: http://img.shields.io/david/birhoff/mdast-util-to-bemjson.svg

[greenkeeper]:    https://greenkeeper.io/
[greenkeeper-img]:https://badges.greenkeeper.io/birhoff/mdast-util-to-bemjson.svg

## Requirements

* [Node.js 8+](https://nodejs.org/en/)

## Install

```sh
$ npm install mdast-util-to-bemjson
```

## Usage

```js
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:
```json
{
    "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
-------

Code and documentation copyright 2017 YANDEX LLC. Code released under the [Mozilla Public License 2.0](LICENSE.txt).

---
_Source: https://npm.io/package/mdast-util-to-bemjson · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._