Docusaurus

Docusaurusは、ReactとNode.jsで構築された静的サイトジェネレーターです。Markdownファイルを取り込み、ユーザーが期待するすべての機能を備えた完全なドキュメントサイトを作成します。ゼロからウェブサイトを構築するのとは異なり、Docusaurusは難しい部分を代わりに処理してくれます。

このツールはMDXを使用しており、Markdownファイル内にインタラクティブなReactコンポーネントを直接追加できます。これにより、追加の作業なしでドキュメントをより魅力的にすることが可能です。Algoliaによる組み込み検索機能、異なる製品リリースのバージョン管理、そして翻訳ツールを通じて70以上の言語をサポートしています。

静的ファイルを生成するため、ドキュメントの読み込みが高速で、どこでもホスティング可能です。サイトはモバイルデバイスでも優れた動作をし、速度とアクセシビリティのための最新のウェブ標準に準拠しています。

Docusaurusの始め方は簡単で、わずか数分で完了します：

• コンピューターにNode.jsバージョン20以上をインストールし、ターミナルでセットアップコマンドを実行して新しいサイトを作成します。

• docsフォルダー内のMarkdownファイルにドキュメントを書きます。各ファイルがウェブサイトのページになります。

• 設定ファイルを編集して外観をカスタマイズします。色の変更、ロゴの追加、ナビゲーションメニューの設定が可能です。

• ローカルプレビューコマンドを使って作業中の変更をブラウザで即座に確認できます。

• blogフォルダーに日付をファイル名に含むMarkdownファイルを作成してブログ投稿を追加します。

• 公開準備ができたら、ビルドコマンドを実行して静的ファイルを生成し、GitHub Pages、Netlify、Vercelなどのウェブホストにアップロードします。

ツールには詳細なガイドと、困ったときに役立つコミュニティが含まれています。

• MITライセンスの無料かつオープンソース

• ReactとNode.jsで構築

• MarkdownとMDXでコンテンツ作成

• Algolia DocSearchによる組み込み検索

• 製品リリースのバージョン管理

• 70以上の言語をサポート

• ブログとドキュメントを一つのサイトで

• ダークモードとレスポンシブデザイン

• 高速な静的サイト生成

• どのホストにも簡単にデプロイ可能