文档编写指南

目录约定

• 中文文档：docs/src/（不含 en/）
• 英文文档：docs/src/en/（与中文路径一一对应）
• 中文 Demo：docs/demos/（默认）
• 英文 Demo：docs/demos/en/（与中文路径一一对应）
• 图片：docs/src/public/（中英文共用）
• 中文导航：docs/.vitepress/config/zh-theme.ts
• 英文导航：docs/.vitepress/config/en-theme.ts

新增文档

以新增 docs/src/examples/chat/my-feature.md 为例：

1. 编写中文 .md
2. 有交互示例时，在 docs/demos/ 新增 .vue
   • 中文版本：docs/demos/chat/my-feature.vue
   • 英文版本（如有中文内容）：docs/demos/en/chat/my-feature.vue
3. 有图片时，放入 docs/src/public/
4. 在 zh-theme.ts 的 sidebar 中增加链接：

{ text: '我的新特性', link: '/examples/chat/my-feature' },

5. 创建并编写英文文档 docs/src/en/examples/chat/my-feature.md
6. 在 en-theme.ts 的 sidebar 中增加链接：

{ text: 'My Feature', link: '/en/examples/chat/my-feature' },

7. 本地预览：cd docs && pnpm dev

Demo 国际化

命名规则

• 中文版本：docs/demos/xxx.vue（默认）
• 英文版本：docs/demos/en/xxx.vue（路径与中文一一对应，文件名相同）

使用方式

在 markdown 文件中引用对应的 demo：

<!-- 中文文档 -->
<demo vue="../../../demos/chat/history.vue" />

<!-- 英文文档 -->
<demo vue="../../../../demos/en/chat/history.vue" />

需要国际化的内容

Demo 文件中以下内容需要翻译：

类型	示例	处理方式
UI 文案	<button>新建会话</button>	翻译为英文
代码注释	// 获取会话对象	翻译或保留
Schema 内容	label: '姓名'	翻译为英文
alert 消息	alert('复制成功')	翻译为英文

无需国际化的 Demo

以下 demo 无需创建英文版本，直接共用即可：

• 纯英文内容的 demo
• 国际化示例 demo（如 i18n.vue，本身演示 i18n 功能）
• 无文本内容的 demo

英文文档注意事项

从中文复制到英文时，<demo> 和图片的相对路径需多加一层 ../，并将 demo 路径指向 demos/en/：

<!-- 中文 -->
<demo vue="../../../demos/chat/my-feature.vue" />

<!-- 英文 -->
<demo vue="../../../../demos/en/chat/my-feature.vue" />

文档内互相引用用相对路径即可，写法与中文相同。
sidebar / nav 配置中，英文链接需带 /en 前缀。

修改或删除文档

操作	需同步
改正文	更新 src/en/ 下对应文件
重命名 / 移动	同步移动英文文件，更新两个 theme 配置
删除	删除英文镜像文件，更新两个 theme 配置
新增/修改 Demo	同步更新 demos/en/ 下对应文件（如有中文内容）