Git Product home page Git Product logo

doc-react's Introduction

doc-react

react 组件文档:通过markdown语法渲染出组件,快速方便为你的组件写出优美的文档。

如何使用

下载:

npm install raw-loader -dev
npm install doc-react --save

在你webpack的loader添加一行规则:

{
  test: /\.md$/,
  loader : 'raw-loader'
}

代码引入

import Tooltip from 'rc-tooltip'
import docReact from 'doc-react'
import toolipMd from '../doc/tooltip.md'

const Doc = docReact({ Tooltip }, toolipMd)

const Home = () => <div><Doc /></div>;

tooltip.md 部分代码

渲染出

详细demo:https://github.com/canfoo/doc-react/blob/master/example/app.js

doc-react's People

Contributors

canfoo avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

cgb-react

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.