Giter VIP home page Giter VIP logo

react-marked-preview-editor's Introduction

react-markdown-editor

A markdown editor and/or preview

简洁 and 功能全面的 react markdown 编辑器/编译器

Demo

$ git clone https://github.com/yj1438/react-marked-preview-editor
$ npm i
$ npm run example

open http://0.0.0.0:9080/

Installation

npm install --save react-marked-preview-editor

Features

  • 支持 markdown 全语法,包括流程图(需要自行引入 flowchart.js)。(modified from marked
  • 支付同步的 edit/preview
  • 提供一组常用的语法工具按钮

Usage

Using in webpack

import React from 'react';
import { MarkdownEditor } from 'react-marked-preview-editor'
import 'github-markdown-css';

class Editor extends React.Component {
  constructor(props) {
    super(props);
    this.state = {
      content: '## my content'
    }
    setTimeout(() => {
      this.editor.setState({
        content: '## update content'
      })
    }, 3000)
  }

  onContentChange = () => {
  }
  
  render(){
    return (
      <MarkdownEditor
        editorTabs // editor tools
        ref={(c) => { this.editor = c }}
        initialContent={this.state.content} // content
        onContentChange={this.onContentChange} // editor content change event
        tabs={['edit', 'preview']} // tabs item array enum from 'edit'/'preview'
        previewClass={'md-editor-preview markdown-body'} // preview tabs contain className
        textareaClass={'md-editor-textarea'} // textarea tabs contain className
      />
      );
  }
}
export default Editor;

To render the component:

var mdEditor = <MarkdownEditor
  initialContent={'My initial content'}				// content
  onContentChange={onContentChange}						// editor content change event
  editorTabs={true}														// editor tools
  tabs={['preview', 'edit']}                  // tabs item array enum from 'edit'/'preview'
  previewClass={'md-editor-preview markdown-body'}		// preview tabs contain className
  textareaClass={'md-editor-textarea'}								// textarea tabs contain className
/>;

ReactDOM.render(mdEditor, document.getElementById('react-container-1'));
<head>
  <meta charset="utf-8">
  <!-- 可以全局引入以下辅助 js/css,加强 react-marked-preview-edit 的功能 -->
  <!-- flowchart + raphael 绘制流程图 -->
  <script src="../node_modules/raphael/raphael.js"></script>
  <script src="../node_modules/flowchart.js/release/flowchart.js"></script>
  <!-- 标准 github 的样式 -->
  <link rel="stylesheet" type="text/css" href="../node_modules/github-markdown-css/github-markdown.css">
</head>
<body>
  <div id="react-container-1">
  </div>
</body>

react-markdown-editor

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.