跳到主要内容

发布 Docusaurus 国际化

·5 分钟阅读
Sébastien Lorber
Docusaurus 维护者,《本周 React》编辑

今天,我们正式发布 Docusaurus 2 i18n (国际化),作为 2.0.0-alpha.71 的一部分。

Docusaurus 2 现已达到与 Docusaurus 1 的功能完全对等。🎉 很快,在进行一些额外的基础设施更新和更多测试之后,第一个 Docusaurus 2 beta 版本将发布。

我们付出了额外的努力,新的 i18n 支持甚至比 Docusaurus 1 更好

在这篇文章中,我们将向您介绍翻译工作流程,解释一些设计决策,并展示刚刚上线的早期采用者网站JestRedwoodDatagit

我们还在 Docusaurus 2 网站本身上“试吃”了 i18n 支持,并且这篇文章已经提供了英文版法文版

翻译您的网站

您可以通过3个简单步骤翻译 Docusaurus 网站

  1. 配置:在 docusaurus.config.js 中声明默认语言环境和替代语言环境
  2. 翻译:将翻译文件放在正确的文件系统位置
  3. 部署:使用单域或多域策略构建和部署您的网站

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

i18n 教程是最佳入门方式,我们提供了使用 GitCrowdin 的帮助。

设计决策

Docusaurus i18n 系统的目标是

  • 简单:只需将翻译文件放在正确的文件系统位置
  • 灵活的翻译工作流程:使用 Git(单体仓库、分支或子模块)、SaaS 软件、FTP
  • 灵活的部署选项:单域、多域或混合
  • 模块化:允许插件作者提供 i18n 支持
  • 低开销运行时:文档大多是静态的,不需要大型 JS 库或 polyfills
  • 可扩展的构建时间:允许独立构建和部署本地化网站
  • 本地化资源:您网站的图片可能包含应翻译的文本
  • 无耦合:不强制使用任何 SaaS,但可以进行集成
  • 易于与 Crowdin 配合使用:多个 Docusaurus 1 网站使用 Crowdin,并且应该能够迁移到 v2
  • 良好的 SEO 默认设置:我们为您设置了有用的 SEO 标头,例如 hreflang
  • RTL 支持:支持从右到左阅读的语言环境(阿拉伯语、希伯来语等),并且易于实现
  • 默认翻译:经典主题标签已为您翻译成多种语言

展示

在发布 i18n 支持之前,我们与一些志愿者合作进行了内部测试

Jest:升级 Docusaurus

我们已经实现了将翻译过的 Docusaurus 1 网站升级到 Docusaurus 2 的可能性。

使用 Docusaurus 1 和 Crowdin 的Jest 便是其中一个网站。

Docusaurus 2 迁移成功,新网站现已投入生产环境 (公告文章)。

Jest's website front page in Japanese

Redwood:采用 Docusaurus

Redwood 是一个 React 全栈 Jamstack 框架。

他们正在寻找创建国际化学习平台的解决方案,并成为 learn.redwoodjs.com 的 Docusaurus 2 i18n 早期采用者,使用 Crowdin 将其翻译成法语。

Redwood's doc page in French

Datagit:使用 LTR 支持

i18n 系统应适用于任何语言,包括从右到左阅读的语言

Datagit.ir 使用波斯语,一个简单的配置选项能够翻转 Docusaurus 主题以添加所需的从右到左支持。

Datagit's website in Persian, a right-to-left language. The sidebar appears on the right of the window and the TOC appears on the left.

结论

我们真诚地希望您能采纳并喜欢新的 i18n 支持。

这项功能并非易事,我们衷心感谢所有参与此过程的人们

  • 感谢Alexey 的帮助,使 i18n 支持更加全面,甚至比 v1 更好
  • 感谢Simen 的志愿服务并支持 Jest 迁移
  • 感谢Claire 在新的 Redwood 平台上采用 Docusaurus 2 并提供了许多反馈
  • 感谢Massoud 审阅我对 LTR 的工作并在 Datagit 上采用它
  • 感谢Crowdin 的支持以及改进其翻译 SaaS 的意愿
  • 感谢 Docusaurus 社区的耐心,并在 GitHub 上提供了许多有用的反馈

感谢阅读。

🙏 欢迎将您全新的 i18n 网站添加到我们的展示页面。我们接受所有精美的 Docusaurus 网站,并且正在进行重新设计,以便您可以按功能筛选网站。