qing-markdown-reader/readme.md

Markdown string tool, input markdown string, return html string

<h1 align="center">qing-markdown-reader</h1>

### 说明
Markdown 字符串工具类，传入 markdown 字符串，返回 html 字符串

### introduce
Markdown string tool, input markdown string, return html string

### 演示项目参考
* [qing-markdown 演示项目](https://github.com/qinkaiyuan/qing-markdown#%E6%BC%94%E7%A4%BA%E9%A1%B9%E7%9B%AE)

### npm 安装
```bash
npm install qing-markdown-reader
```

### 快速上手
```javascript
// 引入
import MdReader from "qing-markdown-reader";

// hello.md文件内内容为：# hello world
const hello = '# hello world'

//# 输出 <h1>hello world<h1>
console.log(MdReader.read(hello))
```

### 结合其他项目使用
* [qing-markdown](https://github.com/qinkaiyuan/qing-markdown#qing-markdown) Vue Markdown 组件，可以将本地或远程 .md 文件以及 markdown 字符串解析为 HTML 显示

* [qing-markdown-loader](https://github.com/qinkaiyuan/qing-markdown-loader#qing-markdown-loader) Webpack loader，加载 .md 文件，并返回文件内内容字符串，
以实现使 webpack 可加载 .md 文件的功能