# @fish-kit/md-tools-plugin-react

> To convert JSX which is written in Markdown to React.Element.

Latest version **0.1.10** (published 2020-06-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @fish-kit/md-tools-plugin-react
pnpm add @fish-kit/md-tools-plugin-react
yarn add @fish-kit/md-tools-plugin-react
bun add @fish-kit/md-tools-plugin-react
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.10 |
| Published | 2020-06-24 |
| First published | 2020-06-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 18.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | pengxing |
| Maintainers | mraiguo |
| Keywords | md-tools, plugin, markdown, react |

## Links

- npm: https://www.npmjs.com/package/@fish-kit/md-tools-plugin-react
- Repository: http://git.sdp.nd/component-h5/md-tools
- Homepage: http://git.sdp.nd/component-h5/md-tools/tree/master/packages/md-tools-plugin-react
- Issues: http://git.sdp.nd/component-h5/md-tools/issues
- npm.io page: https://npm.io/package/@fish-kit/md-tools-plugin-react

## Dependencies (5)

- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.0
- [babel-core](https://npm.io/package/babel-core.md) ^6.21.0
- [babel-types](https://npm.io/package/babel-types.md) ~6.11.1
- [babel-traverse](https://npm.io/package/babel-traverse.md) ~6.10.4
- [babel-generator](https://npm.io/package/babel-generator.md) ~6.11.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.10 (latest) — 2020-06-24

## README

# md-tools-plugin-react

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

## 用法

1. 安装依赖:

```bash
npm i -D md-tools-plugin-react
```

2. 在主题index配置 plugins 中增加`md-tools-plugin-react`.

```js
module.exports = {
  plugins: ["md-tools-plugin-react?lang=__react"]
};
```

3. 在Makdown文件中:

<pre>
...

This is a button:

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

...
</pre>

如上代码可以渲染成:

![screenshot](https://raw.githubusercontent.com/benjycui/md-tools/master/packages/md-tools-plugin-react/screenshot.png)

## API

### lang: String

> default: '__react'

代码块标识

### 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

---
_Source: https://npm.io/package/@fish-kit/md-tools-plugin-react · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._