# element-markdown

> A boilerplate to create element component

Latest version **1.0.0** (published 2016-03-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install element-markdown
pnpm add element-markdown
yarn add element-markdown
bun add element-markdown
```

## 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.0 |
| Published | 2016-03-16 |
| First published | 2016-03-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | fraserxu |

## Links

- npm: https://www.npmjs.com/package/element-markdown
- npm.io page: https://npm.io/package/element-markdown

## Dependencies (2)

- [yo-yo](https://npm.io/package/yo-yo.md) ^1.1.1
- [marked](https://npm.io/package/marked.md) ^0.3.5

## Recent versions

- 1.0.0 (latest) — 2016-03-16

## README

element-markdown
==================

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Downloads][downloads-image]][downloads-url]
[![js-standard-style][standard-image]][standard-url]

A yo-yo component for rendering Markdown with [marked](https://github.com/chjj/marked).

### Intall

```sh
$ npm i element-markdown
```

### Usage

```JavaScript
var yo = require('yo-yo')
var Markdown = require('element-markdown')

function render () {
  var opts = {
    gfm: false
  }

  return yo`
    <div>
    ${Markdown('I\'m a [marked](https://github.com/chjj/marked) rendered **markdown** content.', opts)}
    </div>
  `
}

var app = render()
document.body.appendChild(app)
```

API `Markdown(source, opts)`

* source - Markdown source String
* opts - Marked options

Check [marked](https://github.com/chjj/marked) for available options.

### License

MIT

[npm-image]: https://img.shields.io/npm/v/element-markdown.svg?style=flat-square
[npm-url]: https://npmjs.org/package/element-markdown
[travis-image]: https://img.shields.io/travis/fraserxu/element-markdown/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/fraserxu/element-markdown
[downloads-image]: http://img.shields.io/npm/dm/element-markdown.svg?style=flat-square
[downloads-url]: https://npmjs.org/package/element-markdown
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[standard-url]: https://github.com/feross/standard

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