Package Exports

react-markdown

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-markdown) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

react-markdown

Renders Markdown as pure React components.

Demo available at http://rexxars.github.io/react-markdown/

Installing

npm install --save react-markdown

Basic usage

var React = require('react');
var ReactMarkdown = require('react-markdown');

var input = '# This is a header\n\nAnd this is a paragraph';

React.render(
    <ReactMarkdown source={input} />,
    document.getElementById('container')
);

Notes

If you either set escapeHtml or skipHtml to true, this component does not use dangerouslySetInnerHTML at all.

Options

source - string The Markdown source to parse (required)
className - string Class name of the container element (default: '').
containerTagName - string Tag name for the container element, since Markdown can have many root-level elements, the component need to wrap them in something (default: div).
escapeHtml - boolean Setting to true will escape HTML blocks, rendering plain text instead of inserting the blocks as raw HTML (default: false).
skipHtml - boolean Setting to true will skip inlined and blocks of HTML (default: false).
sourcePos - boolean Setting to true will add data-sourcepos attributes to all elements, indicating where in the markdown source they were rendered from (default: false).
softBreak - string Setting to br will create <br> tags instead of newlines (default: \n).

Developing

git clone git@github.com:rexxars/react-markdown.git
cd react-markdown
npm install
npm test