Skip to content

jianliaoim/react-lite-markdown

Repository files navigation

React Lite Markdown

Build status

Introduction

React markdown renderer of 简聊

Usage

Install

npm i react-lite-markdown --save

Library

React = require 'react'

LiteMarkdown = React.createFactory require 'react-lite-markdown'

React.render LiteMarkdown(), document.body

Stylesheet (It's optional, you can @import your own prefer.)

@import "~react-lite-markdown/style/markdown.css";

Examples

Read example for full details.

# props
T = React.PropTypes

propTypes:
  name: T.string # For classname appear in component, with "is-#{@props.name}".
  value: T.string # Markdown content.
  className: T.string # Markdown content classname.

Develop

  • First, you should npm i to install dependencies.
  • Run npm start to begin dev mode with Webpack Dev Server.
  • Once completed, run npm test see if test is passed.

Welcome to contribute.

License

MIT