Skip to content

Commit a12b753

Browse files
committed
docs: update README
1 parent 39e9c65 commit a12b753

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

packages/pro-components/chat/chat-content/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,14 @@ isComponent: true
2929

3030
### 默认聊天格式
3131

32-
对大模型返回的 markdown 数据自动渲染。
32+
- 对大模型返回的 markdown 数据自动渲染。markdown 会内置调用 `t-chat-markdown` 渲染,同时可根据 role(user/assistant)切换样式。
33+
- 用户发送的消息保持默认格式显示,纯文本会做 HTML 转义并用 rich-text 渲染;
3334

3435
{{ base }}
3536

3637
### 纯文本聊天
3738

38-
用户发送的消息保持默认格式显示,没有高亮效果
39+
用户发送的消息保持默认格式显示,纯文本会做 HTML 转义并用 rich-text 渲染;
3940

4041
{{ text }}
4142

packages/pro-components/chat/chat-list/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ isComponent: true
3434
{{ hook-component }}
3535

3636
#### 自定义
37+
`t-chat-message`支持`content`自定义,使用建议:渲染聊天消息统一用 `t-chat-content`;仅在需要“单独使用 Markdown 组件”或自定义管线时使用 `t-chat-markdown`。也支持别的 markdown 渲染组件,选择其他 markdown 渲染库由用户自行安装。
3738
{{ custom }}
3839

3940
## 场景化示例

packages/pro-components/chat/chat-message/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ isComponent: true
2929

3030
#### 配置消息属性
3131

32+
支持`avatar``name``datetime``content`插槽自定义, `content`插槽使用建议:渲染聊天消息统一用 `t-chat-content`;仅在需要“单独使用 Markdown 组件”时使用 `t-chat-markdown`。也支持别的 markdown 渲染组件,选择其他 markdown 渲染库由用户自行安装。
33+
3234
{{ content }}
3335

3436
### 02 组件状态

0 commit comments

Comments
 (0)