从 CLI 开始:在 Workers 上搭建 Docusaurus 项目,并选择模板。
npm create cloudflare@latest -- my-docusaurus-app --framework=docusaurusyarn create cloudflare my-docusaurus-app --framework=docusauruspnpm create cloudflare@latest my-docusaurus-app --framework=docusaurus或直接部署:使用 Docusaurus 创建文档站点并部署到 Cloudflare Workers,CI/CD 与预览均已为你配置好。
Docusaurus ↗ 是一个开源框架,用于构建、部署和维护文档网站。它基于 React 构建,提供直观的方式创建以文档为重点的静态网站。
Docusaurus 设计为易于使用和自定义,是开发者和组织快速创建文档站点的热门选择。
-
使用 create-cloudflare CLI (C3) 创建新项目。
npm create cloudflare@latest -- my-docusaurus-app --framework=docusaurus --platform=workersyarn create cloudflare my-docusaurus-app --framework=docusaurus --platform=workerspnpm create cloudflare@latest my-docusaurus-app --framework=docusaurus --platform=workers幕后发生了什么?
运行此命令时,C3 会创建新的项目目录,启动 Docusaurus 官方搭建工具 ↗,并为 Cloudflare 配置项目。随后会提供立即将应用部署到 Cloudflare 的选项。
-
在本地开发。
创建项目后,在项目目录中运行以下命令以启动本地开发服务器。
npm run devyarn run devpnpm run dev -
部署项目。
你可以从本地机器或任何 CI/CD 系统(包括 Workers Builds)将项目部署到
*.workers.dev子域或自定义域名。使用以下命令进行构建和部署。若使用 CI 服务,请相应更新你的「deploy command」。
npm run deployyarn run deploypnpm run deploy
若 Docusaurus 项目完全预渲染(通常如此),请按以下步骤操作:
-
添加 Wrangler 配置文件。
在项目根目录创建 Wrangler 配置文件,内容如下:
{ "name": "my-docusaurus-app", // Update to today's date // Set this to today's date "compatibility_date": "2026-08-17", "assets": { "directory": "./build" } }name = "my-docusaurus-app" # Set this to today's date compatibility_date = "2026-08-17" [assets] directory = "./build"此配置的作用是什么?
此配置的关键部分是
assets字段,它告诉 Wrangler 静态资源的位置。此处我们让 Wrangler 在./build目录中查找。若资源位于其他目录,请相应更新directory值。 参阅其他静态资源配置选项。还要注意此配置中没有
main字段——因为你仅提供静态资源,按需渲染/SSR 不需要 Worker 代码。 -
构建并部署项目。
你可以从本地机器或任何 CI/CD 系统(包括 Workers Builds)将项目部署到
*.workers.dev子域或自定义域名。使用以下命令进行构建和部署。若使用 CI 服务,请相应更新你的「deploy command」。npx docusaurus buildyarn docusaurus buildpnpm docusaurus buildnpx wrangler@latest deployyarn wrangler@latest deploypnpm wrangler@latest deploy
绑定(binding)是将 Docusaurus 项目连接到其他 Cloudflare 服务的方式,使应用能够存储和检索数据。
通过绑定(binding),你的应用程序可以与 Cloudflare Developer Platform 完全集成,让你访问计算、存储、AI 等功能。