跳過主要內容

Docusaurus 2020 回顧

·閱讀時間：6 分鐘
Sébastien Lorber
Sébastien Lorber
Docusaurus 維護者、《本週 React 要聞》（This Week In React）編輯

2020 對 Docusaurus 來說是美好的一年，儘管 開頭令人遺憾，且對所有人而言都是動盪的一年。

我們持續投資 Docusaurus 2，並讓它達到與 Docusaurus 1 的功能完全相同。

我們現在建議使用 Docusaurus 2，作為開啟新 Docusaurus 專案的預設選項，並鼓勵 v1 用戶 遷移到 Docusaurus 2。

我們仍處於 alpha 版，但預計很快就會有好消息！

Three Docusaurus plushies laid side-by-side on the table

Docusaurus 2 亮點​

今年我們執行了許多功能，並想突顯其中最重要的功能。

  • i18n：可輕鬆轉譯您的 Docusaurus 網站，即將發布！(預覽, 文件)
  • 版本下拉式選單：啟用情境版本切換
  • 版本控管選項：解決使用版本控管時最常見的痛點
  • 情境式搜尋：在目前版本中搜尋，使用全新 DocSearch 3 體驗
  • Markdown 頁面：使用 Markdown 取代 React 元件來建立獨立頁面
  • 更好的佈景主題：各種使用者介面、使用者體驗與無障礙性功能改進
  • PWA：為您的網站新增加離線支援，並使其可安裝
  • 快速失敗：嚴格的設定檔驗證、偵測斷裂的連結並防止錯誤的生產部署
  • 多個執行個體：在單一網站上兩次使用文件外掛程式(例如：iOS/Android SDK 文件)
  • 移轉 CLI：自動化從 Docusaurus 1 升級
  • CodeSandbox：透過 new.docusaurus.io 從您的瀏覽器輕鬆評估 Docusaurus
  • 金絲雀版本：使用 @canary npm 標籤，讓其他人搶先使用即將推出的版本
  • TypeScript：漸進採用內部程式碼，並改進使用者的使用方式
  • 發佈 Infima：它現在是 開源軟體

Docusaurus 2 成長​

2019 年從頭開始 重建 Docusaurus 的計畫收到了回報：在緩慢的開局後，Docusaurus 2 已被廣泛採用，並且已經超越 Docusaurus 1 的使用情況。

Docusaurus v1 vs. v2 npm trends of the year 2020. The installations of Docusaurus v2 is visibly up-growing, while v1 is slightly downward. V1 starts at 15000 and ends at 10000, while v2 starts at 2000 and ends at 25000. The intersection happens around June 2020.

著名的專案、新創、大型公司和個人採用了 Docusaurus 2 (展示)

我們協助規模較大的 Docusaurus 1 網站進行升級，確保有適當的移轉路徑和功能相容性。

React Native 已成功升級到 Docusaurus 2 (已封存的 v1 網站)

React Native's new website built with Docusaurus v2

已在地化的 Docusaurus 1 網站(如Jest)也可以升級

Jest's new website built with Docusaurus v2 in Japanese

我們還看到，第一個從右到左的 Docasaurus 2 網站已發佈。

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.

GitHub 活動​

  • 星星數：14,632 → 20,946（年增率 43.2%）
  • 總貢獻者數：303 → 512（年增率 68.9%）。其中大部分為非 Facebook 貢獻者
  • 每週 npm 下載數：2,356 → 25,592（年增率 986%）
  • 在 GitHub 上，Docusaurus 1 已被 6,311 個專案使用（年增率 62.9%），而 Docusaurus 2 已被 5,039 個專案使用（年增率 1,940%）

與 Major League Hacking 的合作​

我們已經歡迎Major League Hacking（MLH）的研究員參與兩個季了。

對於他們提供的各種貢獻，例如以下案例，我們非常感謝

  • 撰寫 v1 至 v2 遷移 CLI 的基礎
  • 協助將 React Native 網站從 v1 遷移至 v2
  • 使組態驗證更嚴格且更完整，並傳回有用的錯誤訊息
  • 新增 CodeSandbox 支援
  • 改善 CI 管線：建置大小和 Lighthouse 機器人

我們期待在 2021 年繼續這種合作。

媒體​

Dmitry Vinnik（Facebook 的開發人員倡導者）在60 秒或15 分鐘影片中說明 Docusaurus。

Rachel Nabors（Facebook 的文件工程師）在React Native Radio 178（Podcast）中談論了有關 Docusaurus 的一些內容，William Candillon 則在React Native 網站遷移（影片）中說明了相關內容。

許多部落格文章已經發佈

社群​

Docusaurus 社群持續成長，Discord 伺服器相當活躍，且 Stack Overflow 問題 不斷被張貼。

Docusaurus 2 的模組化架構讓社群能夠建立並發布 第三方外掛程式。由於我們想讓社群更團結，如果您正在建置外掛程式，請 讓我們知道。

下一步是什麼？ ​

由於 Docusaurus 2 的核心功能已經建置完成，我們能夠投入更多時間來解決社群回報的痛點和臭蟲，並讓 Docusaurus 穩定且便利到足夠進入測試版和候選版本階段。

透過適當地支援國際化 (i18n) 和版本控管，以及大型規模的遷移，例如 React Native 和 Jest ，我們現在有了一條明確的遷移路徑，適用於所有 Docusaurus 1 網站。

我們還是有幾個主要功能想著手進行

非常感謝社群在 2020 年的貢獻，特別是

讓我們一起為 2021 年乾杯！ 🎉