docs: 更新文档

Author: xiaweiss

.github/workflows/npm-publish.yml

@@ -18,6 +18,7 @@ jobs:
           registry-url: https://registry.npmjs.org/
       - run: npm i pnpm@latest -g
       - run: pnpm install
+      - run: pnpm run test
       - run: pnpm run build
       - run: pnpm publish --no-git-checks
         env:

.gitignore

@@ -8,6 +8,7 @@ pnpm-debug.log*
 lerna-debug.log*
 
 node_modules
+coverage
 dist
 dist-ssr
 *.local

README.md

@@ -1,8 +1,131 @@
 # Anby
-![license](https://img.shields.io/npm/l/miniprogram-unicode-segmenter)
-![downloads](https://img.shields.io/npm/dt/miniprogram-unicode-segmenter)
-![npm](https://img.shields.io/npm/v/miniprogram-unicode-segmenter)
+![license](https://img.shields.io/npm/l/anby)
+![downloads](https://img.shields.io/npm/dt/anby)
+![npm](https://img.shields.io/npm/v/anby)
+
+安装 `pnpm install anby`
 
 ## parseHTML
 
-基于状态机实现的 html 解析器
+基于状态机实现的 html 宽松解析器，转换为 js 对象，方便做富文本渲染。
+
+```javascript
+import { parseHTML } from 'anby'
+
+parseHTML('<p>123</p>').doc
+
+// result
+{
+  type: 'doc',
+  content: [{
+    type: 'p',
+    content: [{
+      type: 'text',
+      text: '123'
+    }]
+  }]
+}
+```
+
+### 配置项
+
+#### alias
+标签别名，用于更改 tag 名称
+
+```js
+parseHTML('<p>123</p>', {
+  alias: {
+    p: 'paragraph'
+  }
+}).doc
+
+// result
+{
+  type: 'doc',
+  content: [{
+    type: 'paragraph',
+    content: [{
+      type: 'text',
+      text: '123'
+    }]
+  }]
+}
+```
+
+也可以根据父子关系修改，如 `'audio > p'`
+
+```js
+parseHTML('<audio><p>123</p></audio>', {
+  alias: {
+    'audio > p': 'audioText'
+  }
+}).doc
+
+// result
+{
+  type: 'doc',
+  content: [{
+    type: 'audio',
+    content: [{
+      type: 'audioText',
+      content: [{
+        type: 'text',
+        text: '123'
+      }]
+    }]
+  }]
+}
+```
+
+#### markRule
+节点解析为编辑器 marks。类似 tiptap 的 mark 规则，将包裹修饰的标签，转换为 marks 属性
+
+```js
+parseHTML('<p><strong>加粗</strong></p>', {
+    markRule: [{
+      type: 'strong',
+      mark: {type: 'bold'}
+    }]
+  }).doc
+
+// result
+{
+  type: 'doc',
+  content: [{
+    type: 'p',
+    content: [{
+      type: 'text',
+      marks: [
+        {type: 'bold'}
+      ],
+      text: '加粗'
+    }]
+  }]
+}
+```
+
+#### selfClose
+自定义自闭合标签
+
+常见的自闭合标签库已处理，可以额外指定自闭合标签
+
+注意：如果标签自带反斜杠，则无需配置，例如 `<note />`
+
+```js
+parseHTML('<p><note>123</p>', {
+  selfClose: ['note']
+}).doc
+
+{
+  type: 'doc',
+  content: [{
+    type: 'p',
+    content: [{
+      type: 'note',
+    }, {
+      type: 'text',
+      text: '123'
+    }]
+  }]
+}
+```

package.json

@@ -13,7 +13,7 @@
     "changelog": "conventional-changelog -i CHANGELOG.md -s",
     "lint": "tsc --noEmit",
     "build": "tsc && vite build",
-    "test": "vitest",
+    "test": "vitest run",
     "coverage": "vitest run --coverage"
   },
   "keywords": [],

src/parseHTML.ts

@@ -41,12 +41,12 @@ interface Data {
 }
 
 export interface ParseHTMLConfig {
-  /** 标签别名 */
+  /** 标签别名，用于更改 tag 名称，也可以根据父子关系修改，如 'audio > p' */
   alias?: Record<string, string>
-  /** 自闭合标签 */
-  selfClose?: string[]
-  /** 节点解析为编辑器 marks */
+  /** 节点解析为编辑器 marks。类似 tiptap 的 mark 规则，将包裹修饰的标签，转换为 marks 属性 */
   markRule?: MarkRule[]
+  /** 自定义自闭合标签（注意：如果标签自带反斜杠，则无需配置，例如 `<note />`）*/
+  selfClose?: string[]
 }