MkDocs

MkDocs ↗ は、プロダクト、社内ナレッジベース、API をドキュメント化できる、現代的なドキュメントプラットフォームです。

MkDocs には、比較的新しい Python と、Python のパッケージマネージャーである pip が必要です。pip のインストールは、MkDocs Installation ガイド ↗ を参照してください。pip をインストールしたら、次を実行します。

pip install mkdocs

mkdocs new コマンドで新しいアプリケーションを作成します。

mkdocs new <PROJECT_NAME>

プロジェクトへ cd し、MkDocs とその依存関係を requirements.txt ファイルへ書き出します。

pip freeze > requirements.txt

すべてのフレームワークガイドは、Git ↗ の基本的な理解があることを前提としています。Git を初めて使う場合は、この Git ハンドブックの要約 ↗ で、ローカルマシンへの Git のセットアップ方法を確認してください。

SSH でクローンする場合は、GitHub に対して push または pull する各コンピューターで SSH キーを生成 ↗ する必要があります。

詳細は GitHub のドキュメント ↗ と Git のドキュメント ↗ を参照してください。

repo.new ↗ にアクセスして、新しい GitHub リポジトリを作成します。作成後、新しく作ったプロジェクトディレクトリに移動します。次のコマンドをターミナルで実行して、ローカルアプリケーションを GitHub へプッシュします。

git init
git remote add origin https://github.com/<your-gh-username>/<repository-name>
git add .
git commit -m "Initial commit"
git branch -M main
git push -u origin main

GitHub リポジトリを作成し、MkDocs プロジェクトをそのリポジトリへプッシュできました。

サイトを Pages にデプロイするには、次の手順を実行します。

1. Cloudflare ダッシュボードで Workers & Pages ページを開きます。

   Workers & Pages を開く ↗

2. Create application を選びます。

3. Pages タブを選びます。

4. Import an existing Git repository を選びます。

5. 作成した新しい GitHub リポジトリを選び、Begin setup を選びます。

6. Set up builds and deployments セクションで、次の情報を入力します。

7. Environment variables (advanced) > Add variable を開き、変数 PYTHON_VERSION に値 3.7 を追加します。

サイトをデプロイすると、プロジェクト専用の *.pages.dev サブドメインが割り当てられます。

MkDocs サイトへ新しいコードをコミットするたびに、Cloudflare Pages はプロジェクトを自動で再ビルドしてデプロイします。新しい pull request では プレビューデプロイ も使えるため、本番へデプロイする前に変更後の見た目を確認できます。

最初のサイトを Cloudflare Pages へデプロイする全体の手順は、Get started ガイド を参照してください。

このガイドを完了すると、MkDocs サイトを Cloudflare Pages にデプロイできています。ほかのフレームワークを始めるには、Framework ガイドの一覧 を参照してください。