DocusaurusをGitHub Pagesで動かす
このサイト(sawara.me)はDocusaursで作成し、GitHub Pagesでホストしています。
オープンソースのDocusaurusとオンラインプラットフォームのGitHubを組み合わせることで、無料で簡単にサイトを公開することができます。
今回はDocusaurusとGitHub Pagesという機能を使ったサイトの公開方法について紹介します。
Docusaurusとは
Docusaurusは、Meta(旧Facebook)が開発しているオープンソースの静的サイトジェネレーターです。主にソフトウェアのドキュメントサイトを作成するために設計されていますが、ブログ機能やカスタムページ作成機能も充実しており、個人ブログやポートフォリオサイトとしても非常に優秀です。
Reactベースで構築されており、MarkdownやMDX(Markdownの中でReactコンポーネントを使える形式)を使って、素早く美しく、かつ高速なサイトを作成できるのが特徴です。
公式サイト: https://docusaurus.io/
GitHub Pagesとは
GitHub Pagesは、GitHubのリポジトリから直接Webサイトをホストできるサービスです。HTML、CSS、JavaScriptファイルをリポジトリにプッシュするだけで、無料でサイトを公開できます。
Docusaurusのような静的サイトジェネレーターと の相性が非常に良く、ビルドしたファイルをGitHub Pagesにデプロイすることで、サーバーの管理をすることなくサイトを運用できます。
GitHub Pagesのドキュメント: https://docs.github.com/ja/pages
GitHubでリポジトリを作成
GitHubのアカウントを持っていない人はまずGitHubのアカウントを作成してください。
GitHubにログイン後ヘッダーの「+」ボタンから「New Repository」を選択して、リポジトリを作成します。
リポジトリとはプログラムのソースコード(ファイル)を管理する場所です。Docusaurusのプロジェクトファイルを管理するための場所を作るイメージです。
「Repository Name」を入力して、「Create repository」をクリックすれば作成完了です。

「Repository Name」を<GitHubアカウント名>.github.io という名前で作成すれば、そのまま https://<GitHubアカウント名>.github.io というURLで公開できるようになります。
今回私は「sample-doc」というリポジトリを作成しましたが、その場合でも https://sawarame.github.io/sample-doc/ という形で公開することができます。
Docusaurusインストール
次に、ローカルでDocusaurusのプロジェクトを作成し、GitHubにプッシュします。
ローカルのターミナルを開いて下記コマンドを実行し、Docusaurusのプロジェクトを作成します。
npx create-docusaurus@latest <