MkDocs

MkDocs ↗ 是一个现代的文档平台，团队可以在其中记录产品、内部知识库和 API。

安装 MkDocs

MkDocs 需要在系统上安装较新版本的 Python 和 Python 包管理器 pip。要安装 pip，请参阅 MkDocs 安装指南 ↗。安装 pip 后，运行：

pip install mkdocs

创建 MkDocs 项目

使用 mkdocs new 命令创建新应用：

mkdocs new <PROJECT_NAME>

然后 cd 进入项目，将 MkDocs 及其依赖写入 requirements.txt 文件：

pip freeze > requirements.txt

继续之前

所有框架指南都假定你已具备 Git ↗ 的基础知识。如果你是 Git 新手，请参阅这份精简 Git 手册 ↗，了解如何在本地设置 Git。

如果你使用 SSH 克隆，则必须在每台用于向 GitHub 推送或拉取的计算机上生成 SSH 密钥 ↗。

更多信息请参阅 GitHub 文档 ↗和 Git 文档 ↗。

创建 GitHub 仓库

访问 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 项目推送到该仓库。

使用 Cloudflare Pages 部署

要将站点部署到 Pages：

在 Cloudflare 仪表板中，前往 Workers & Pages 页面。
Go to Workers & Pages ↗
选择 Create application（创建应用程序）。
选择 Pages 选项卡。
选择 Import an existing Git repository（导入现有 Git 仓库）。
选择你创建的新 GitHub 仓库，然后选择 Begin setup（开始设置）。
在 Set up builds and deployments（设置构建和部署） 部分，提供以下信息：

Configuration option	Value
Production branch	`main`
Build command	`mkdocs build`
Build directory	`site`

前往 Environment variables (advanced)（环境变量（高级）） > Add variable，添加变量 PYTHON_VERSION，值为 3.7。

部署站点后，你将在 *.pages.dev 上获得项目的唯一子域名。

每次向 MkDocs 站点提交新代码时，Cloudflare Pages 都会自动重新构建并部署您的项目。您还可以在新 pull request 上获得预览部署，以便在将更改部署到生产环境之前预览网站的显示效果。

有关将第一个站点部署到 Cloudflare Pages 的完整指南，请参阅快速入门指南。

了解更多

完成本指南后，你已成功将 MkDocs 站点部署到 Cloudflare Pages。要开始使用其他框架，请参阅框架指南列表。