SuperAPI AI 工具集

x-markdown

前端与建站

查看项目

更新于 10-15 18:46

技能介绍

用途:以 @antdv-next/x-markdown 正确且可预测地渲染 Markdown,适用于构建或审查 Markdown 渲染场景。

主要能力:基础渲染与包边界说明;LLM 流式输出及不完整语法处理;为聊天或数据展示块做自定义组件映射;插件、主题与安全渲染默认值。

包边界:UI 层 @antdv-next/x(聊天 UI、气泡列表、发送器);数据层 @antdv-next/x-sdk(Provider、请求、流式数据流、状态管理);渲染层 @antdv-next/x-markdown(Markdown 解析、流式渲染、插件、主题、自定义渲染器)。注意 x-markdown 不是聊天状态工具,应在 x 与 x-sdk 产出消息数据后再渲染内容。

必要用法:最小示例 import { XMarkdown } from "@antdv-next/x-markdown"; export default () => <XMarkdown content="# Hello" />;。建议先读 CORE.md 完成普通渲染;内容分块到达时加 STREAMING.md;需要自定义标签、插件、语法块或主题时加 EXTENSIONS.md;用 API.md 确认属性名与默认值。

开发规则:使用稳定的 components 对象,不要在每次渲染时新建内联组件映射;最后一个分块设置 streaming.hasNextChunk = false,否则不完整占位符不会刷新为最终内容;谨慎处理原始 HTML,需要以文本显示时用 escapeRawHtml,必须渲染时保持 dompurifyConfig 显式且最小;主题覆盖保持最小,从 x-markdown-light 或 x-markdown-dark 起步只覆盖必要变量;自定义组件依赖完整语法时按 streamStatus === 'done' 分支。

适用场景:聊天中丰富助手回复(x-chat-provider → x-request → use-x-chat → x-markdown)、内置 Provider 的 Markdown 回复、独立 Markdown 页面或文档查看器。

限制:资料未提供具体安装命令、包版本、价格与平台信息;渲染原始 HTML 与主题细节需参考 CORE.md、STREAMING.md、EXTENSIONS.md、API.md 及官方文档。