MkDocs
MkDocs是一个现代文档平台,团队可在此记录产品、内部知识库和应用程序接口。
安装 MkDocs
MkDocs 要求系统安装最新版本的 Python 和 Python 包管理器 pip。要安装 pip,请参阅 MkDocs 安装指南。安装好 pip 后,运行
创建一个 MkDocs 项目
使用 mkdocs new
命令创建新应用程序:
然后cd
进入你的项目,将 MkDocs 及其依赖项放入requirements.txt
文件:
在你继续之前
所有框架指南都假定你已经对 Git 有了基本了解。如果你是 Git 的新手,请参考这本 Git 手册摘要,了解如何在本地机器上设置 Git。
如果使用 SSH 克隆,则必须在每台用于从 GitHub 推送或拉取的计算机上 生成 SSH 密钥。
创建 GitHub 仓库
访问 repo.new,创建一个新的 GitHub 仓库。创建新仓库后,进入新创建的项目目录,准备并在终端运行以下命令将本地应用程序推送到 GitHub:
你已成功创建了一个 GitHub 仓库,并将 MkDocs 项目推送到该仓库。
使用 Cloudflare 页面部署
将网站部署到页面:
- 登录 Cloudflare 仪表板 并选择你的账户。
- 在账户主页,选择 工作者和页面> 创建应用程序> 页面> 连接到 Git。
- 选择你创建的新 GitHub 仓库,在设置构建和部署部分,选择 MkDocs作为你的框架预设。你的选择将提供以下信息:
Configuration option | Value |
---|---|
Production branch | main |
Build command | mkdocs build |
Build directory | site |
- 转到 环境变量(高级)> 添加变量> 添加变量
PYTHON_VERSION
并设置值为3.7
。
部署网站后,你将在 *.pages.dev
上为你的项目收到一个唯一的子域。
每次你向 MkDocs 网站提交新代码时,Cloudflare Pages 都会自动重建你的项目并进行部署。你还可以访问新拉取请求上的 预览部署,并在部署到生产环境之前预览网站更改的外观。
有关将你的第一个网站部署到 Cloudflare Pages 的完整指南,请参阅 入门指南。
了解更多
完成本指南后,你已成功将 MkDocs 网站部署到 Cloudflare Pages。要开始使用其他框架,请参阅框架指南列表