markdown-it-react-component - npm Package Compare versions

Comparing version 0.1.0-beta.1 to 0.1.0

package.json

 {
   "name": "markdown-it-react-component",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0",
   "description": "Plugin to support react component for markdown-it markdown parser",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # markdown-it-react-component
 Plugin to support react component for markdown-it markdown parser
+
+With this plugin you can support react component like:
+
+```
+::: rc
+function Hello(props){
+    return (
+        <div>
+            Hello:
+            <p style={{color:'red'}}>{props.text}</p>
+        </div>
+    )
+}
+return (
+    <div>
+        <Hello text="World"/>
+    </div>
+);
+:::
+```
+
+## Installation
+
+Only browser:
+
+```bash
+$ npm install markdown-it-react-component --save
+```
+
+## API
+
+```js
+import MarkdownIt from "markdown-it";
+import { SupportReactComponent } from "../index";
+
+const md = new MarkdownIt().use(md => SupportReactComponent(md,[, options]))
+```
+
+* options:
+    - components - optional,React Component to provide plugin.
+
+### Params
+
+## Example
+See [markdown-it-react-component-example](https://github.com/LinFeng1997/markdown-it-react-component-example/blob/master/index.js)
+
+### Use Antd React Components
+
+See [markdown-it-react-component-antd-example](https://github.com/LinFeng1997/markdown-it-react-component-example/blob/master/antd.js)
+
+## License
+
+[MIT](https://github.com/LinFeng1997/markdown-it-react-component/blob/master/LICENSE) 

No alert changes

Improved metrics

Total package byte prevSize

9636

increased by12.95%

Number of lines in readme file

55

increased by1733.33%

No dependency changes