跳至主要内容

发布 Docusaurus 国际化

·阅读 4 分钟
Sébastien Lorber
Docusaurus 维护者,This Week In React 编辑

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

Docusaurus 2 现在已经达到了 **与 Docusaurus 1 的完整功能奇偶性**。🎉 很快,在进行了一些额外的基础设施更新和更多测试之后,**第一个 Docusaurus 2 Beta 版本**将发布。

**我们加倍努力**,新的国际化支持 **比 Docusaurus 1 更好**。

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

我们还在 **Docusaurus 2 网站本身** 上 **试用** 国际化支持,这篇文章已经可以用 英语法语 阅读!

翻译您的网站

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

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

国际化支持 **非常灵活** 并且基于 **文件系统**。

**国际化教程** 是开始的最佳方式,我们提供帮助来使用 **Git** 或 **Crowdin**。

设计决策

Docusaurus 国际化系统的目标是

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

展示

我们与一些志愿者合作,在发布之前 **试用国际化支持**。

Jest:升级 Docusaurus

我们已经实现了 **升级** **已翻译的 Docusaurus 1 网站** 到 Docusaurus 2 的功能。

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

Docusaurus 2 迁移成功,新网站现在已部署到生产环境中 (发布公告)。

Jest's website front page in Japanese

Redwood:采用 Docusaurus

Redwood 是一个 React 全栈 Jamstack 框架。

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

Redwood's doc page in French

Datagit:使用 LTR 支持

国际化系统应该适用于任何语言,包括 **从左到右的语言**。

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.

结论

我们真诚地希望您会采用并喜欢新的国际化支持。

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

  • Alexey 为他的帮助使国际化支持变得全面,甚至比 v1 更好
  • Simen 为志愿参与并支持 Jest 迁移
  • Claire 为在新的 Redwood 平台上采用 Docusaurus 2 并提供许多反馈
  • Massoud 为审查我对 LTR 的工作并将其应用到 Datagit
  • Crowdin 为他们的支持以及愿意改进其翻译 SaaS
  • Docusaurus 社区为他们的耐心,并在 GitHub 上提供了许多有用的反馈

感谢您的阅读。

🙏 并且请将您的全新国际化网站添加到我们的 展示页面。我们接受任何经过打磨的 Docusaurus 网站,我们正在努力 重新设计,让您可以按功能对网站进行筛选。