mdBook は、Markdown ファイルに基づいた静的サイトジェネレータであり、個人のブログ、ドキュメントページ、またはウェブサイトを素早く作成するために使用できます。以下に、自分のウェブサイトを mdBook でデプロイするための簡単な手順があります:
-
mdBook のインストール:GitHub ページにアクセスして、最新バージョンの mdBook をダウンロードし、公式ドキュメントに従ってインストールします。
-
mdBook プロジェクトの作成:ローカルコンピュータ上で新しい mdBook プロジェクトを作成します。次のコマンドを使用できます:
mdbook init mysite ```
これにより、現在のディレクトリに名前が「mysite」の新しいプロジェクトが作成されます。
-
Markdown ファイルの作成:mdBook プロジェクトの「src」フォルダに、Markdown 形式のドキュメントを作成します。これらのドキュメントは自動的に HTML ページに変換されます。ドキュメントの内容は Markdown 構文を使用して記述することもできますし、ページのレイアウトやナビゲーションの追加など、mdBook が提供する特殊な構文を使用することもできます。
-
サイトのプレビュー:生成されたサイトをローカルでプレビューするには、次のコマンドを使用します:
mdbook serve --open
これにより、ローカルサーバーが起動し、生成されたサイトをブラウザでプレビューすることができます。http://localhost:3000にアクセスすることで確認できます。
-
サイトのビルド:サイトの外観と内容に満足したら、次のコマンドを使用して最終的な静的サイトファイルをビルドします:
mdbook build ```
これにより、「dist」という名前のフォルダが生成され、生成された HTML、CSS、JavaScript などのファイルが含まれます。
- サイトのデプロイ:生成された「dist」フォルダを Web サーバーまたは静的ホスティングプラットフォーム(例:GitHub Pages、Netlify など)にアップロードすることで、ウェブサイトをインターネット上にデプロイできます。
GitHub にリポジトリをアップロードした後、[Settings] をクリックし、[Pages] を見つけます。ここでは、GitHub Pages を使用してウェブサイトをデプロイします。
その後、[Build and Deployment] を操作し、ソースの [GitHub Action] を選択します。
その後、mdBook の [Configure] をクリックし、デフォルトの設定を使用します。
コードを提出した後、GitHub Action の実行が終了するのを待って、自分のウェブサイトのホームページが完成します。