Przeglądaj źródła

doc: 完善说明文文档

zhupei 1 rok temu
rodzic
commit
d829c5729f
2 zmienionych plików z 8 dodań i 4 usunięć
  1. 7 3
      README.md
  2. 1 1
      package.json

+ 7 - 3
README.md

@@ -1,10 +1,14 @@
 # dify-markdown-parse
 
-此项目为`vue`插件,用于`vue3`项目
+此项目仅能用于`vue3`项目中,核心功能为解析`markdown`文本
 
-核心为`markdown`的文本解析
+如果主项目是`react`项目,可直接使用`react-markdown`进行`markdown`的解析和展示
 
-此项目参考`dify`使用的`react-markdown`,并进行相应的改写,使得`dify`的`markdown`解析方案能用于`vue3`项目中。
+如果主项目是`vue`项目,则可以考虑使用此方法进行`markdown`的解析和展示。
+
+此项目参考`dify`中使用的`react-markdown`,并进行相应的改写,使得`dify`的`markdown`解析方案能用于`vue3`项目中。
+
+`dify`中的`markdown`解析方法较为复杂,并不是单纯的将`markdown`源字符串进行解析然后展示,而是经过了解析、抽象语法树的构建、react组件的生成等一系列工作,最终在界面上呈现出`markdown`的解析结果。所以和直接解析`markdown`源字符串并展示的方案相比,可能存在一些细节上的差异。
 
 ## 使用方法
 

+ 1 - 1
package.json

@@ -1,6 +1,6 @@
 {
   "name": "dify-markdown-parse",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "dify的markdown解析方案",
   "main": "index.js",
   "scripts": {