跳转到内容
搜索文档

Docusaurus

最后更新 查看 MarkdownAgent 设置

Docusaurus 是一个静态网站生成器。它利用 React 的强大功能构建具有快速客户端导航的单页应用程序,使您的网站具有交互性。它提供开箱即用的文档功能,但也可以用于创建任何类型的网站,例如个人网站、产品网站、博客或营销落地页。

设置新项目

使用 create-cloudflare CLI (C3) 设置您的项目。C3 将创建一个新的项目目录,初始化 Docusaurus 的官方设置工具,并提供立即部署的选项。

要使用 create-cloudflare 创建新的 Docusaurus 项目,请运行以下命令:

npm create cloudflare@latest -- my-docusaurus-app --framework=docusaurus --platform=pages

create-cloudflare 将安装其他依赖项,包括 Wrangler CLI 以及任何必要的适配器,并向您提问配置问题。

继续之前

所有框架指南都假定你已具备 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

使用 Cloudflare Pages 部署

通过 create-cloudflare CLI (C3) 部署

如果你使用 create-cloudflare(C3) 创建新的 Docusaurus 项目,C3 将安装项目所需的所有依赖,并提示你通过 CLI 部署项目。如果部署,你的站点将上线,并会提供部署 URL。

通过 Cloudflare 仪表板部署

要将站点部署到 Pages:

  1. 在 Cloudflare 仪表板中,前往 Workers & Pages 页面。

    Go to Workers & Pages ↗
  2. 选择 Create application(创建应用程序)

  3. 选择 Pages 选项卡。

  4. 选择 Import an existing Git repository(导入现有 Git 仓库)

  5. 选择你创建的新 GitHub 仓库,然后选择 Begin setup(开始设置)

  6. Build settings(构建设置) 部分,选择 Docusaurus 作为 Framework preset(框架预设)。你的选择将提供以下信息:

Configuration optionValue
Production branchmain
Build commandnpm run build
Build directorybuild

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

每次您向 Docusaurus 站点提交新代码并将这些更改推送到 GitHub 时,Cloudflare Pages 都会自动重新构建您的项目并进行部署。您还将在新的拉取请求 (PR) 上获得预览部署,并能够在将更改部署到生产环境之前预览更改在站点上的效果。

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

了解更多

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

这篇文档对您有帮助吗?