# react-markdown-el

> A simple React component that parses and renders markdown text

Latest version **1.0.2** (published 2015-04-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-markdown-el
pnpm add react-markdown-el
yarn add react-markdown-el
bun add react-markdown-el
```

## 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.2 |
| Published | 2015-04-15 |
| First published | 2014-10-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Sean Adkinson |
| Maintainers | sadkinson |
| Keywords | react, markdown, component, element, reactjs, parse |

## Links

- npm: https://www.npmjs.com/package/react-markdown-el
- Repository: https://github.com/odysseyscience/react-markdown-el
- Issues: https://github.com/odysseyscience/react-markdown-el/issues
- npm.io page: https://npm.io/package/react-markdown-el

## Dependencies (2)

- [markdown](https://npm.io/package/markdown.md) ^0.5.0
- [object-assign](https://npm.io/package/object-assign.md) ^2.0.0

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2015-04-15
- 1.0.1 — 2015-04-07
- 1.0.0 — 2014-10-09
- 0.0.1 — 2014-10-03

## README

react-markdown-el
===========================

Provides a simple `React` component that renders markdown text in an element.

Install
-----------

    $ npm install react-markdown-el

Usage
------------

Basic usage just takes in markdown as a `text` property:

    var Markdown = require('react-markdown-el');

    ...
    render: function() {
      var text = "This *is* some `markdown` [text](http://example.com)";
      return (
        <Markdown text={text}/>
      )
    }


This will render a `<div>` with `class="markdown"` by default.  You can change the tag, or add your own properties very easily:

    <Markdown el="a"
              href="http://example.com"
              className="custom-markdown-link"
              text={text} />

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