跳至主要內容

發佈 Docusaurus i18n

·閱讀時間:4 分鐘
Sébastien Lorber
Docusaurus 維護者、本週 React 編輯

今天,我們正式發布Docusaurus 2 i18n國際化),做為 2.0.0-alpha.71 的一部分。

Docusaurus 2 現在已達到與 Docusaurus 1 完全相容。🎉 很快,在經過一些額外的基礎建設更新和更多測試後,第一個 Docusaurus 2 beta 版就會發布。

我們更上一層樓,Docusaurus 1中的全新 i18n 支援甚至更上一層樓

在本文中,我們將會向您展示翻譯工作流程、說明部分設計決策,並展示剛上線的早期採用網站JestRedwoodDatagit

我們也對Docusaurus 2 網站本身進行了 i18n 支援的實際測試,而本文也已提供 英文法文 版本!

翻譯您的網站

您可以在3 個簡單步驟中翻譯 Docusaurus 網站

  1. 設定:在 docusaurus.config.js 中宣告預設語言環境和備用語言環境
  2. 翻譯:將翻譯檔案放在 正確的檔案系統位置
  3. 部署:使用單一或多重網域策略建立並部署網站

i18n 支援非常彈性,並根據檔案系統

i18n 教學課程 是入門的最佳途徑,我們提供使用 GitCrowdin 的協助。

設計決策

Docusaurus i18n 系統的目標是

  • 簡潔:只需將翻譯檔案放在 正確的檔案系統位置
  • 彈性的翻譯工作流程:使用 Git( монорепо、分歧或子模組)、 SaaS 軟體、FTP
  • 彈性的部署選項:單一、多重網域或混合
  • 模組化:允許外掛程式作者提供 i18n 支援
  • 低執行時期負擔:文件大多是靜態的,不需要耗費大量的 JS 函式庫或 polyfill
  • 可縮放的建立時間:允許獨立建立並部署當地語言網站
  • 本地化素材:網站上的一張圖像可能包含應該翻譯的文字
  • 無關聯:不強制使用任何 SaaS,但整合是有可能的
  • 易於與 Crowdin 一起使用:多個 Docusaurus 1 網站使用 Crowdin,並且應該能夠轉移到 v2 版本
  • 良好的 SEO 預設值:我們為您設定有用的 SEO 標頭,例如 hreflang
  • RTL 支援:支援從右到左閱讀的語言環境(阿拉伯語、希伯來語等),且易於實作
  • 預設翻譯:經典主題標籤已翻譯成 多國語言

展示

在釋出之前,我們與一些志工合作使用 i18n 支援

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 i18n 的早期採用者,使用 Crowdin 將 learn.redwoodjs.com 翻譯成法文。

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,採用 Redwoof 新平台 Docusarus 2,並提供許多回饋
  • 馬蘇德,審閱我在 LTR 上的工作,並於 Databit 採用
  • 克勞丁,感謝他們的支持及提昇 SaaS 翻譯的意願
  • Docusaurus 社群,感謝他們的耐心等待,並於 GitHub 上提供許多有用的回饋

感謝您的閱讀。

🙏 請將您新建立的 i18n 網站加入我們的 展示頁面。我們接受任何拋光的 Docusaraus 網站,並且我們正努力 重新設計,讓您能依功能過濾網站。