Docsify

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

Docsifyは、リポジトリのdocsディレクトリにあるMarkdownファイルから、瞬時にドキュメントサイトを生成するドキュメントジェネレーターです。詳細はDocsifyの公式サイトをご覧ください。

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

前提条件

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

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

  1. GitHubにログイン後、「Kinsta – Hello World – Static Site With Docsify」テンプレートから新規リポジトリを作成します(「Use this template」>「Create a new repository」)。
  2. MyKinstaで、「静的サイト」>「サイトの追加」>「GitHub」を選択し、「Gitサービスの接続」ウィンドウで「Gitサービスを接続する」をクリックして、GitHubアカウントにログインします。
  3. Hello World Docsifyリポジトリを選択し、「続行」をクリックします。「ビルド設定」は、ビルドコマンドNodeバージョンは空白、公開ディレクトリが「docs」に設定されていることを確認した上で、「サイトを作成」をクリックします。

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

デプロイの完了後に表示されるDocsifyのウェルカムページ
デプロイの完了後に表示されるDocsifyのウェルカムページ

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

デプロイメントを開始すると(静的サイトの作成、またはコミットの失敗による再デプロイ)、ビルドコマンドが実行され、Publish Directoryコンテンツがデプロイされます。

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