Docusaurus 2020 年の振り返り

2020 年は、Docusaurusにとって素晴らしい年でした。 残念な始まり と、誰もが大変な年ではありましたが。

私たちは Docusaurus 2 への投資を続け、Docusaurus 1 との完全な機能互換性を実現しました。

新しい Docusaurus プロジェクトを開始する際のデフォルトの選択肢として、Docusaurus 2 を推奨しており、v1 ユーザーには Docusaurus 2 への移行 をお勧めしています。

まだアルファ版ですが、まもなく朗報が期待できます！

Docusaurus 2 のハイライト

今年は多くの機能に取り組みましたが、最も重要なものをいくつかご紹介します。

• i18n：Docusaurus サイトを簡単に翻訳できます。近日リリース！（プレビュー、ドキュメント）
• バージョン切り替えドロップダウン：状況に応じたバージョンの切り替えを有効にします。
• バージョン管理オプション：バージョン管理における一般的な問題点を解決します。
• 状況に応じた検索：現在のバージョン内で検索し、最新の DocSearch 3 エクスペリエンスを使用します。
• Markdown ページ：React コンポーネントの代わりに Markdown を使用して、スタンドアロンのページを作成します。
• 改良されたテーマ：UI、UX、アクセシビリティの改善を行いました。
• PWA：サイトにオフラインサポートを追加し、インストール可能にします。
• 早期エラー検出：厳格な設定検証、壊れたリンクの検出、不正な本番環境へのデプロイの防止を行います。
• 複数インスタンス：単一のサイトでドキュメントプラグインを 2 回使用できます（例：iOS/Android SDK ドキュメント）。
• 移行 CLI：Docusaurus 1 からのアップグレードを自動化します。
• CodeSandbox：new.docusaurus.io を使用して、ブラウザから簡単に Docusaurus を評価できます。
• カナリアリリース：@canary npm タグを使用して、他の人より先に今後のリリースを使用できます。
• TypeScript：内部コードへの段階的な導入、およびユーザー向けの使用方法の改善。
• Infima の公開：現在 オープンソースです。

Docusaurus 2 の成長

2019 年に Docusaurus をゼロから作り直す計画 は成功しました。遅れはありましたが、Docusaurus 2 は広く採用され、すでにDocusaurus 1 の使用数を上回っています。

注目すべきプロジェクト、スタートアップ、大企業、個人が Docusaurus 2 を採用しました（事例紹介）

• Supabase
• React Navigation
• React Redux
• Vector
• Algolia DocSearch
• SAP Cloud SDK
• Palo Alto Cortex XSOAR
• Quddús George のウェブサイト

私たちは、適切な移行パスと機能互換性を確保し、大規模な Docusaurus 1 サイトのアップグレードを支援しました。

React Native は Docusaurus 2 に正常に移行されました（アーカイブされた v1 サイト）

Jest のようなローカライズされた Docusaurus 1 サイトもアップグレードできます。

また、最初の右から左への記述 をサポートする Docusaurus 2 サイトが公開されました。

GitHub のアクティビティ

• スター数：14632 → 20946 (+43.2% 年間)
• 総コントリビューター数：303 → 512 (+68.9% 年間)。そのほとんどは Facebook 以外のコントリビューターです。
• 週間 npm ダウンロード数：2356 → 25592 (+986% 年間)
• GitHub では、Docusaurus 1 は 6311 件のプロジェクトで使用されており (+62.9% 年間)、Docusaurus 2 は 5039 件のプロジェクトで使用されています (+1940% 年間)。

Major League Hacking との協業

私たちはすでに 2 シーズンにわたって 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（ポッドキャスト） で Docusaurus について少し話し、William Candillon は React Native ウェブサイトの移行（ビデオ） について話しました。

多くのブログ記事が公開されています。

• Docusaurus の製作者たちへ by Quddus George
• Redoc と Docusaurus を使用したより充実した API ドキュメント by David Goss
• Docusaurus v2 のプラグインを作成する方法 by Adriaan Knapen
• React Tracked ドキュメントウェブサイトと Docusaurus v2 by Daishi Kato
• Docusaurus を使用した簡単なドキュメント作成 by Anshul Goyal（MLH フェロー）
• Docusaurus を使用して美しいドキュメントウェブサイトを構築する by Victoria Lo

コミュニティ

Docusaurus コミュニティは成長を続けており、Discord サーバーは非常にアクティブで、Stack Overflow の質問 が投稿され続けています。

Docusaurus 2 のモジュール式アーキテクチャにより、コミュニティは サードパーティプラグイン を作成して公開することができました。コミュニティをより良く連携させるために、プラグインを開発している場合は、お知らせください。

今後の展望

Docusaurus 2 のコア機能がついに完成したので、コミュニティから報告された問題点やバグの解決に時間を割き、Docusaurus を安定して使いやすくし、ベータ版とリリース候補版に移行することができます。

i18n とバージョン管理、そしてReact Native や Jest などの大規模な移行を適切にサポートすることで、すべての Docusaurus 1 サイトに移行パスが明確になりました。

まだ取り組みたい主要な機能がいくつかあります。

• テーマギャラリーを作成することで、テーマ間の切り替えを容易にし、ファーストクラスの Tailwind サポートを含めます。
• Webpack 5 にアップグレードすることで、パフォーマンスとビルド時間を改善します。
• CommonMark との互換性を向上させることで、MDX との競合を減らし、CommonMark ベースのサイトが Docusaurus を採用しやすくなります。
• MDX 2.0 にアップグレードする。
• 2021 年中に発見される可能性のあるその他のタスク

2020 年の 貢献 に対して、コミュニティに多大なる感謝を申し上げます。特に

• Docusaurus を作成し、長年にわたってプロジェクトをサポートしてくれた Joel Marcey に感謝します。
• コアチーム - Alexey Pyltsyn、Sébastien Lorber、Yangshun Tay に感謝します。
• 大きな影響を与えてくれた Major League Hacking と Facebook のインターンに感謝します。
• DocSearch 3とそのサポートにご尽力いただいたAlgoliaチーム
• React Nativeへの移行への投資にご尽力いただいたBartosz Kaszubowski氏
• 貢献と相互サポートをいただいたコミュニティ全体に感謝いたします。

素晴らしい2021年でした！🎉