Appearance
翻译指南
感谢你参与文档翻译工作 — 我们非常欢迎贡献!下面是推荐的翻译流程(目前我们主要支持 zh):
基本流程
- 从
docs/guide/复制英文页面到docs/zh/guide/并保持文件名一致。 - 翻译文案,注意保持代码块、front-matter(如果存在)和链接(指向其他中文页面时请加
/zh/前缀)。 - 在本地运行 docs:
bash
pnpm docs:dev
# 或者
pnpm docs:build- 提交 PR,并标注
docs和i18n(可选)。
链接处理
- 指向其他文档的链接在中文页面中,请使用中文路径:例如
(/zh/guide/quick-start)。 - 对外部链接无需更改。
风格与口吻
- 对技术名词保持一致翻译(例如 Monaco、Mermaid、KaTeX 等),不确定时可保留英文原词并在括号中加入译名。
- 代码示例不要改动语法,只翻译周边解释文字。
本地预览与校验
- 使用
pnpm docs:dev本地预览,顶部右侧可以切换语言。 - 确认导航(sidebar)是否正常显示中文页面。
PR 检查清单
- [ ] 翻译文件放置在
docs/zh/guide/并保持文件名一致 - [ ] 指向其他文档的链接指向对应
zh页面 - [ ]
pnpm docs:build可以成功构建 - [ ] PR 描述中文翻译范围与说明
如果你希望我添加 GitHub Action,自动检查 PR 翻译或链接问题,我可以继续添加这项功能。再次感谢你的贡献!