# belmark

> creates dom nodes from markdown

Latest version **2.0.3** (published 2017-01-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install belmark
pnpm add belmark
yarn add belmark
bun add belmark
```

## 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 | 2.0.3 |
| Published | 2017-01-02 |
| First published | 2016-12-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | @serapath |
| Maintainers | serapath |
| Keywords | markdown, bel, marked |

## Links

- npm: https://www.npmjs.com/package/belmark
- Repository: https://github.com/serapath/belmark
- Homepage: https://github.com/serapath/belmark#readme
- Issues: https://github.com/serapath/belmark/issues
- npm.io page: https://npm.io/package/belmark

## Dependencies (2)

- [bel](https://npm.io/package/bel.md) ^4.5.1
- [marked](https://npm.io/package/marked.md) ^0.3.6

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 2.0.3 (latest) — 2017-01-02
- 2.0.2 — 2016-12-27
- 2.0.1 — 2016-12-26
- 2.0.0 — 2016-12-26
- 1.0.1 — 2016-12-26
- 1.0.0 — 2016-12-26

## README

# belmark
creates dom nodes from markdown

# usage
`npm install belmark`

```js
var belmark = require('belmark')
var markdown = `
  # Hello
  * world
`
var opts = { gfm: false }
/****************************
  as function call
****************************/
var el   = belmark.call(opts, markdown)
// or with default `opts`
var el   = belmark(markdown)
document.body.appendChild(el)
/****************************
  as tagged template
****************************/
var el2 = belmark.bind(opts)`
  # Hello
  * world
`
// or with default `opts`
var el2 = belmark`
  # Hello
  * world
`
document.body.appendChild(el2)
```

for more details see: [demo](https://serapath.github.io/belmark)

# api

`var element = belmark.call(opts, source)`

* `source` - Markdown source String
* `opts` - options object for `marked` provided as `this` param
  * check [marked](https://www.npmjs.com/package/marked) for available options

# related
inspiration came from
* https://www.npmjs.com/package/beldown
* https://www.npmjs.com/package/element-markdown

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