国际化

GemBook 很容易让文档站支持多语言,语言代码显示在 URL 路径中:/{lang}/path。 没有语言代码的路径(例如 / 或者旧的链接)会重定向到浏览器偏好的语言,否则重定向到默认语言。

启用国际化

  1. 使用 --i18n 或者 i18n 启用国际化

  2. 将文档移动到以语言代码命名的文件夹中,例如:

    docs/
    ├── en
    │   ├── guide
    │   │   ├── README.md
    │   │   └── installation.md
    │   ├── 003-about.md
    │   └── README.md
    └── zh
        ├── guide
        │   ├── README.md
        │   └── installation.md
        └── README.md

默认语言为 en,没有 en 时为第一个语言,使用 fallbackLanguage 指定。

语言代码的支持请查看这里,网站本身的文本(例如“编辑此页”)支持中文和英文,其他语言使用英文。

未翻译的文档

只有标题(frontmatter 和 # 标题)的文档是未翻译的文档,构建时会机器翻译默认语言中同一路径的文档并显示提示;翻译失败时显示原文。

目录名称本地化

默认情况下目录名称会直接渲染到侧边栏中,如果需要本地化目录名称有两种方法:

  • 修改目录名称,例如将 docs/zh/guide 改成 docs/zh/002-指南
  • 在目录中添加 config.yml 文件指定 title