md-tools-plugin-component-react

md-tools的一个插件，用于支持React组件文档系统编译

Usage no npm install needed!

<script type="module">
  import mdToolsPluginComponentReact from 'https://cdn.skypack.dev/md-tools-plugin-component-react';
</script>

README

md-tools-plugin-component-react

把 Markdown 里的 jsx 代码块转换成 React.Element.

用法

  1. 安装依赖:
npm i -D md-tools-plugin-component-react
  1. 在主题index配置 plugins 中增加md-tools-plugin-component-react.
module.exports = {
  plugins: ["md-tools-plugin-component-react?lang=jsx"]
};
  1. 在Makdown文件中:
...

This is a button:

```jsx
import { Button } from 'antd';
ReactDOM.render(<Button>Click!</Button>, mountNode);
```

...

如上代码可以渲染成:

screenshot

import { Button } from 'antd';
ReactDOM.render(&lt;Button&gt;Click!&lt;/Button&gt;, mountNode);

API

lang: String

default: 'jsx'

代码块标识

babelConfig: Object

default: { presets: [ 'react', ['env', { targets: { browsers: ['last 2 versions', 'Firefox ESR', '> 1%', 'ie >= 8', 'iOS >= 8', 'Android >= 4'], }, }], ], plugins: [ 'transform-class-properties', 'transform-object-rest-spread', ], }

babel 配置

noreact: Boolean

default: false

是否自动引入 React 和 ReactDOM .

License

MIT