Docusaurus

こちらのページでは、弊社静的サイトホスティングサービスで、GitHubリポジトリからDocusaurusを使用して静的サイトをセットアップする方法の例をご紹介します。

Docusaurusは、必要最小限のコーディングで簡単に作成可能なドキュメントサイトの構築に特化した静的サイトジェネレーターです。詳細は、Docusaurusの公式サイトをご覧ください。

なお、以下のテンプレートは、弊社アプリケーションホスティングでもセットアップなしでご利用いただけます。アプリケーションホスティングでは、最初のデプロイ時に必要なコマンドが自動検出されるため、ウェブプロセスのstartコマンドは空白のままで問題ありません。

前提条件

  • 弊社クイックスタートテンプレートは、GitHubに保存・管理されているため、GitHubアカウントが必要です。
  • アプリケーションのデプロイには、MyKinstaアカウントが必要になります。

Docusaurus静的サイトをデプロイする

  1. GitHubにログイン後、「Kinsta – Hello World – Docusaurus」テンプレートから新規リポジトリを作成します(「Use this template」>「Create a new repository」)。
  2. MyKinstaで、「静的サイト」>「サイトの追加」>「GitHub」を選択し、「Gitサービスの接続」ウィンドウで「Gitサービスを接続する」をクリックして、GitHubアカウントにログインします。
  3. Hello World Docusaurusリポジトリを選択して「続行」をクリックし、以下のビルド設定で静的サイトを追加します。
    • ビルドコマンドnpm run build
    • Nodeバージョン:18.16.0
    • 公開ディレクトリ:build

package.jsonファイルで定義された依存関係は、デプロイメントプロセス中に自動インストールされます。デプロイの完了後は、すぐにサイトをご利用いただけます。サイトのURLには、Docusaurusのデフォルトページが表示されます。

デプロイ完了後に表示されるDocusaurusのデフォルトページ
デプロイ完了後に表示されるDocusaurusのデフォルトページ

デプロイメントライフサイクル

デプロイメントを開始すると(アプリケーションの作成、またはコミットの失敗による再デプロイ)、npm buildコマンド、その後にnpm startコマンドが実行されます。

この記事は役に立ちましたか?