此项目仅能用于vue3项目中,核心功能为解析markdown文本

zhupei d829c5729f doc: 完善说明文文档 1 jaar geleden
src d40237e9ad feat: initiate repo 1 jaar geleden
.gitignore d40237e9ad feat: initiate repo 1 jaar geleden
README.md d829c5729f doc: 完善说明文文档 1 jaar geleden
index.js b2c120de8e fix: 修复文件引用错误 1 jaar geleden
package-lock.json d40237e9ad feat: initiate repo 1 jaar geleden
package.json d829c5729f doc: 完善说明文文档 1 jaar geleden

README.md

dify-markdown-parse

此项目仅能用于vue3项目中,核心功能为解析markdown文本。

如果主项目是react项目,可直接使用react-markdown进行markdown的解析和展示。

如果主项目是vue项目,则可以考虑使用此方法进行markdown的解析和展示。

此项目参考dify中使用的react-markdown,并进行相应的改写,使得difymarkdown解析方案能用于vue3项目中。

dify中的markdown解析方法较为复杂,并不是单纯的将markdown源字符串进行解析然后展示,而是经过了解析、抽象语法树的构建、react组件的生成等一系列工作,最终在界面上呈现出markdown的解析结果。所以和直接解析markdown源字符串并展示的方案相比,可能存在一些细节上的差异。

使用方法

安装

$ npm install --save git+http://gitlab.smartai.com/zhupei/dify-markdown-parse.git

在项目中使用

import difyMarkdownParse from 'dify-markdown-parse'

const markdown = `
# hello world

* 苹果
* 香蕉
`

const result = difyMarkdownParse(markdown);

console.log(result); // 请查看下方输出结果

输出结果

<h1>hello world</h1>
<ul>
<li>苹果</li>
<li>香蕉</li>
</ul>