MkDocs

MkDocsは、プロジェクトドキュメントの構築のために特別に設計された、速く、シンプルで非常にエレガントな静的サイトジェネレータです。ドキュメントのソースファイルはMarkdownで記述され、単一のYAML設定ファイルで設定されます。

デモビデオ

以下はデモビデオで、60秒以内にMkDocsプロジェクトを初期化してZeaburにデプロイする方法を示しています。

以下の条件を満たす場合、ZeaburはあなたのプロジェクトをMkDocsプロジェクトとして認識し、自動的にデプロイします：

オープンソースへの貢献に興味がある場合は、zbpackのオープンソースコードで関連部分を見つけることができます。

この記事では、MkDocsプロジェクトを初期化し、Zeaburにデプロイする方法を案内します。

MkDocsプロジェクトを初期化するには、MkDocs公式ドキュメントを参照してください。

pip install mkdocs
mkdocs new my-project
cd my-project

ローカルでMkDocsプロジェクトをテストできます。

mkdocs serve

MkDocsプロジェクトをデプロイするには、GitHubまたはZeabur CLIの2つの方法を選択できます。

Zeabur CLIを使用してMkDocsプロジェクトをデプロイするのは、最も簡単な方法です。まず、Zeabur CLIにログインします：

npx zeabur auth login

このコマンドはブラウザを開いてログインプロセスを案内します。

次に、deploy コマンドを使用してデプロイします：

npx zeabur deploy

このコマンドは対話式にどのプロジェクトにデプロイするかを尋ねますが、新しいプロジェクトを作成することもできます。

Zeabur CLIでのデプロイに関する詳細は、CLIでサービスをデプロイするをご覧ください。

GitHubでデプロイすると、プロジェクトはすぐに使えるCI/CDサービスを享受できます。GitHubにコードをプッシュするだけで、Zeaburが自動的にデプロイを行います。

GitHub上に新しいリポジトリを作成し、その後リポジトリにコードをプッシュしてください。詳細な説明はGitHubドキュメントを参照してください。

プッシュが完了したら、Deploy service をクリックし、Deploy your source code を選択します。

deploy

リポジトリを検索してインポートをクリックすると、サービスが自動的にデプロイを開始します。

デプロイが完了したら、ウェブサイトにドメインを設定する必要があります。

サービスページの「ドメイン」タブを開き、「ドメインを生成」または「カスタムドメイン」をクリックします。

サービスにドメインをバインドする方法の詳細については、ドメインのバインドを参照してください。