跳转至主内容

Docusaurus i18n 发布

· 2 分钟阅读
Sébastien Lorber

Sébastien Lorber

Docusaurus 维护者

今天,随着 2.0.0-alpha.71 的发布,我们正式推出 Docusaurus 2 i18n国际化)功能。

Docusaurus 2 的功能特性现在已可和 Docusaurus 1 等量齐观。 🎉在不久的将来,我们会在更新基础设施并再做些测试后发布 Docusaurus 2 的首个 Beta 测试版本

我们又挥洒了更多汗水,全新的 i18n 功能甚至比 Docusaurus 1 的内置支持更加强大

本篇博文中,我们将向您呈现翻译工作流,并诠释部分设计决策展示已经使用此功能的示例站点,如:JestRedwoodDatagit

我们还自给自足,在自己的 Docusaurus 2 站点上启用了 i18n 功能。您可阅读本篇博文的英文法文中文版本!

翻译您的站点#

您可以遵循以下三步轻松翻译 Docusaurus 站点:

  1. 配置:在 docusaurus.config.js 中声明默认及备选语言
  2. 翻译:将译文文件放置在正确的文件系统位置
  3. 部署:使用单域名或多域名策略构建并部署您的站点

i18n 支持非常灵活,且基于文件系统

您可参见 i18n 教程来轻松上手,我们还提供 GitCrowdin 的翻译方式。

设计决策#

Docusaurus i18n 系统旨在:

  • 简单:仅需将译文文件放置在正确的文件系统位置
  • 弹性翻译流程:可使用 Git(单仓库、派生或子模块)、SaaS 软件或 FTP
  • 弹性部署选项:可部署于单个、多个域名或混合部署
  • 模块化:插件可提供 i18n 支持
  • 快速运行时:文档多为静态,无需重量级的 JS 库或 Polyfill
  • 伸缩构建:允许独立构建及部署本地化内容网站
  • 本地化资源:您网站上的图像可被翻译
  • 无耦合:不强制使用任何 SaaS,但您可自己集成
  • 轻松搭配 Crowdin:多个使用 Crowdin 的 Docusaurus 1 站点均可迁移至 v2
  • 优秀的 SEO 默认值:我们已为您预先设置有用的 SEO 页眉数据(如 hreflang
  • RTL 支持:支持并轻松实现自右向左阅读的语言(阿拉伯语、以色列语等)
  • 默认译文:经典主题的标签已为您翻译成多种语言

案例展示#

我们在发布前与多个组织联系,让其提前使用新版 i18n 支持

Jest:更新 Docusaurus#

我们成功将多国语言的 Docusaurus 1 站点**升级**至了 Docusaurus 2。

使用 Docusaurus 1 及 Crowdin 的 Jest 正是其中之一。

向 Docusaurus 2 的迁移极其成功,新站点已部署至生产环境(公告博文)。

Jest i18n 截图

Redwood:采用 Docusaurus#

Redwood 是一款 React 全栈 Jamstack 框架。

他们正寻求创建国际化学习平台的解决方案,使用 Crowdin 翻译成法语并发布到率先采用 Docusaurus 2 i18n 的 learn.redwoodjs.com 上。

Redwood i18n 截图

Datagit:使用 LTR 支持#

i18n 系统可搭配任何语言,包括从右向左书写的语言

Datagit.ir 使用波斯语,仅需要简单更改一个选项即可调整 Docusaurus 主题并添加所需的从右向左语言支持。

Datagit i18n 截图

结语#

我们由衷希望您喜欢并采用新的 i18n 特性。

打造本功能绝非易事,我们想向这漫漫长征上的每一人表达感谢:

  • 感谢 Alexey 对打造并完善功能全面的 i18n 特性之帮助
  • 感谢 Simen 志愿支持 Jest 迁移
  • 感谢 Claire 在 Redwood 平台上采用 Docusaurus 2 并提供诸多反馈
  • 感谢 Massoud 检查我在 LTR 方面的工作并部署至 Datagit
  • 感谢 Crowdin 的支持及对翻译 SaaS 不断完善
  • 感谢 Docusaurus 社群的耐心等待和在 Github 上提供的许多有用反馈

感谢您的阅读。

🙏最后,还恳请您将您崭新的 i18n 站点添加至我们的展示页面。 我们在此接受任何优美的 Docusaurus 站点,同时我们还正重新设计此页面来让您根据不同功能特性筛选网站。