# markdown-react

**Repository Path**: mirrors_iamdustan/markdown-react

## Basic Information

- **Project Name**: markdown-react
- **Description**: React markdown builder
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-03-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

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

React markdown renderer

*I have switched to https://github.com/jonschlinkert/remarkable for my blog and website, so I'm not sure if I will continue to support this*

What is this?
-------------

A markdown to [React](http://facebook.github.io/react/) renderer.


Parse markdown to a React structure instead of a html. This allows you to all sort of custom things that you can do with react.
This means you can render a normal html structure but also do al sort of crazy things.

This script doesn't parse markdown, instead it uses `evilstreak/markdown-js`. I'm probably going to add an other backend too `chjj/marked`

Some examples can be found in examples. After installation, you can run these (`node examples/simple.js`).
A server example can be found in [react-markdown-server](https://github.com/tcoopman/markdown-react-server)

TODO
----

* better error handling (add a test fase, and do the correct thing on error (render the error for example))
* ~~Clean up the installation~~
* ~~Clean up repo~~
* Build a small example of what is possible with React together with markdown (numbered titles, onClick,...)
* ~~Make this useable for a blog site (compile to React and static HTML)- See [react-markdown-server](https://github.com/tcoopman/markdown-react-server)~~
* Add a backend for: chjj/marked
* More tests and fix the tests to point to lib
* Complete documentation (document api)
* ~~Server example~~
* ~~Publish to npm~~
* Sanitize input

Installation
------------

* clone this repo
* `npm install`

Tests
-----

* clone this repo
* `npm install`
* compile jsx `node_modules/react-tools/bin/jsx --watch --harmony src/ dist/`
* run `node_modules/mocha/bin/mocha`

Build
-----
* clone this repo
* `npm install`
* compile jsx `node_modules/react-tools/bin/jsx --watch --harmony src/ lib/`


Maybe later
-----------

* Use [facebook/immutable-js](https://github.com/facebook/immutable-js) as a for the intermediate tree and implement `shouldComponentUpdate` for fast updates (in case we want to use this as an markdown editor for example.)