国际化

GemBook 很容易让文档站支持多语言,语言代码显示在 URL 路径中:/{lang}/path。 访问网站时如果路径中包含语言代码,则会显示该语言版本,如果没有则根据浏览器设置选择最合适的语言并进行重定向。

启用国际化

  1. 使用 --i18n 启用国际化,这让 GemBook 自动重定向

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

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

语言代码的支持请查看这里

目录名称本地化

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

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