跳转至

文档国际化(i18n)

HiveFlow 使用 mkdocs-static-i18n,采用 文件夹 布局:

docs/
├── assets/          # 共享资源(与语言无关)
├── en/              # 英文(默认)
└── zh/              # 简体中文

贡献者规则

保持英文 在 docs/zh/ 中翻译为中文
代码块、CLI 命令 标题、段落、表格
API 名称(HiveFlow、ECM) 导航标签(在 mkdocs.yml 中)
环境变量(HIVEFLOW_*) 提示框标题
文件路径、PyPI 包名 案例研究叙述

新增页面时:

  1. 创建 docs/en/your-page.md
  2. 创建 docs/zh/your-page.md
  3. 在 mkdocs.yml 的 en 与 zh 的 nav 中分别添加入口

验证

python -m mkdocs build --strict

构建产物为 site/en/ 与 site/zh/,Material 主题提供语言切换器。

仓库 README

文件 语言
README.md English
README.zh.md 简体中文
packages/core/README.md English
packages/core/README.zh.md 简体中文
(agent/、studio/ 同理)