by jrm2k6

A markdown editor using React/Reflux

203 Stars 31 Forks Last release: Not found MIT License 131 Commits 15 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:


A markdown editor using React/Reflux.

Build Status Code Climate License Latest Version Total Downloads


Demo here:


npm install --save react-markdown-editor
yarn add react-markdown-editor


From the UI:

  • Bold
  • Italic
  • Header
  • Subheader
  • Link
  • Unordered List
  • Inline Images

Of course it is a regular markdown editor (using the nice markdown-js library), so you are not limited to the UI.


To render the component: ``` var React = require('react'); var MarkdownEditor = require('react-markdown-editor').MarkdownEditor;

var TestComponent = React.createClass({ render: function() { return ( ); } });

React.render(, document.getElementById('content')); ```

 takes two required props:
- initialContent which is the text you want the textarea to contain on initialization.
- iconsSet which is the icons provider you want to use. It can either be font-awesome or materialize-ui

Optional props:

  • onContentChange
    , function to be called on each content change, getting the new content as an argument (as the property name says!)
  • styles
    , see Styling below

You can also listen to content changes on the editor. If you are using Reflux, by listening to the changes on

. To be able to do so, just


You can modify the styles directly by modifying the styles declared in

. The pre-existing styles assume that you are using Bootstrap and Font Awesome.


 is styled using React's inline styling and can be styled by supplying a 
prop. The following keys are used to style each component, below are their default values:
- styleMarkdownEditorHeader : 
    - display: 'flex'
    - flexDirection: 'column'
    - borderBottom: '1px solid #ddd'
    - marginLeft: '0px'
    - marginRight: '0px'
    - minHeight: '50px'
    - justifyContent: 'center'
    - position: 'relative'
- styleMarkdownEditorContainer :
    - display: 'flex'
    - flexDirection: 'column'
    - marginTop: '2px'
    - paddingTop: '10px'
    - border: '1px solid #ddd'
    - backgroundColor: '#f7f7f7'
- styleMarkdownMenu :
    - margin: '5px 0'
    - flex: '1'
    - display: 'flex'
    - position: 'absolute'
    - right: '20px'
    - top: '10px'
- styleMarkdownTextArea : 
    - height: '90%'
    - width: '100%'
    - padding: '30px 10px'
    - border: 'none'
- styleMarkdownPreviewArea : 
    - height: '90%'
    - width: '100%'
    - padding: '30px 10px'
    - backgroundColor: '#fff'
    - border: 'none'
- styleMarkdownEditorTabs : 
    - border: 'none'
    - display: 'flex'
    - justifyContent: 'flex-start'
- styleTab :
    - padding: '0px 20px'
    - cursor: 'pointer'
    - display: 'flex'
    - justifyContent: 'center'
    - alignItems: 'center'
    - height: '50px'
- styleActiveTab :
    - padding: '0px 20px'
    - cursor: 'pointer'
    - display: 'flex'
    - justifyContent: 'center'
    - alignItems: 'center'
    - height: '50px'
    - borderLeft: '1px solid #ddd'
    - borderRight: '1px solid #ddd'
    - borderTop: '1px solid #ddd'
    - backgroundColor: '#fff'
    - borderRadius: '3px'


  • [ ] Cross-browsers testing
  • [ ] Move to Redux


cd Example
npm install
open index.html


You can open an issue on the github repo, or contact me directly by email.


Please, if you are using this package, let me know. I am interested to know what you think of it, even if it was on a tiny side-project.


Editing tab Editing tab with custom styles Preview tab

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.