https://github.com/simonguo/react-markdown-reader

markdown reader for react
https://github.com/simonguo/react-markdown-reader

Last synced: 12 months ago
JSON representation

markdown reader for react

• Host: GitHub
• URL: https://github.com/simonguo/react-markdown-reader
• Owner: simonguo
• License: mit
• Created: 2017-03-07T01:38:00.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T18:14:33.000Z (over 3 years ago)
• Last Synced: 2025-06-13T22:21:00.281Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 725 KB
• Stars: 8
• Watchers: 3
• Forks: 7
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# react-markdown-reader

## Install

```

npm install html-loader --save-dev

npm install markdown-loader --save-dev

npm install react-markdown-reader --save-dev

```

## Usage

`webpack.config.js`

**webpack >= 2**

```js

const markdownRenderer = require('react-markdown-reader').renderer;

{

  test: /\.md$/,

  use: [{

    loader: 'html-loader'

  }, {

    loader: 'markdown-loader',

    options: {

      renderer: markdownRenderer(/**languages[string]**/)

    }

  }]

}

```

注意： markdownRenderer 参数 languages，是为了按需加载，解决加载所有的语言包文件过大的问题。默认值:

```js

['javascript', 'bash', 'xml', 'css', 'markdown', 'less'];

```

Exmaple

```js

import { Markdown } from 'react-markdown-reader';

import 'react-markdown-reader/less/highlight.less';

{require('./README.md')};

```