部署

要为生产环境构建网站的静态文件，请运行：

npm

npm run build

Yarn

yarn build

pnpm

pnpm run build

完成后，静态文件会被生成在 build 目录中。

备注

Docusaurus 只负责构建站点，然后把静态文件输出到 build 文件夹。

现在，该由你来决定怎么托管这些静态文件了。

你可以把你的网站部署到静态网站托管服务上，比如 Vercel、GitHub Pages、Netlify、Render、Surge，等等。

Docusaurus 网站是静态渲染的，而且一般不需要 JavaScript 也能运行！

配置

在 docusaurus.config.js 中，下面这些参数是必填的，让 Docusaurus 能够优化路由，并从正确的位置加载文件：

参数	描述
url	站点 URL。 如果网站部署在 https://my-org.com/my-project/， url 就是 https://my-org.com/
baseUrl	站点的 base URL，带有末尾斜杠。 如果网站部署在 https://my-org.com/my-project/， baseUrl 就是 /my-project/

本地测试构建

在部署到生产环境前，事先进行本地测试尤为重要。 Docusaurus 提供了 docusaurus serve 命令来测试：

npm

npm run serve

Yarn

yarn serve

pnpm

pnpm run serve

站点默认会部署在 http://localhost:3000/。

末尾斜杠配置

Docusaurus 有一个 trailingSlash 配置，允许你自定义 URL 链接和输出的文件名格式。

你一般不需要修改默认值。 遗憾的是，每家静态托管商的行为都不一样，而把同一网站部署到不同服务商的结果可能大相径庭。 根据你的托管商的不同，你可能需要修改此配置。

提示

要更好地了解你的托管商的行为，可以参见 slorber/trailing-slash-guide，并依此配置 trailingSlash 选项。

使用环境变量

把可能敏感的信息放在环境变量中的做法很常见。 然而，在典型的 Docusaurus 网站中， docusauurus.config.js 文件是唯一一个可以接触到 Node.js 环境的地方（参见我们的架构概述）。除此之外的所有东西（MDX 页面，React 组件等等），都处于客户端中，不能直接访问 process 全局变量。 在这种情况下，你可以考虑使用 customFields 将环境变量传递给客户端。

docusaurus.config.js

// 如果你正在使用 dotenv (https://www.npmjs.com/package/dotenv)
import 'dotenv/config';

export default {
  title: '...',
  url: process.env.URL, // 你也可以通过环境变量来控制站点细节
  customFields: {
    // 把你的自定义环境放在这里
    teamEmail: process.env.EMAIL,
  },
};

home.jsx

import useDocusaurusContext from '@docusaurus/useDocusaurusContext';

export default function Home() {
  const {
    siteConfig: {customFields},
  } = useDocusaurusContext();
  return <div>通过 {customFields.teamEmail} 联系我们！</div>;
}

选择托管服务商

有几种常见的托管选择：

• 自行托管，借助 HTTP 服务器，例如 Apache2 和 Nginx。
• Jamstack 提供商（例如，Netlify 和 Vercel）。 我们会以它们为参考，但同样的道理也可以适用于其他提供商。
• GitHub Pages（就定义而言，它也算是 Jamstack，但我们单独列出它来进行对比）。

如果你不清楚选择哪一个，问自己下面几个问题：

我愿意为其投资多少资源（金钱、个人时间，或是其他）？

• 🔴 自行托管要求网络以及 Linux 和 web 服务器管理方面的经验。 这是最困难的选项，需要最多的时间来成功管理。 就费用而言，云服务几乎永远不会是免费的，而购买/部署本地服务器的费用甚至可能更高。
• 🟢 Jamstack 提供商可以几乎瞬间帮你建立一个运作的网站，并且提供易于配置的功能，像是服务端重定向。 许多提供商提供了非常慷慨的构建时间配额，甚至免费套餐也够用，你基本不会超过限额。 但是，免费计划也存在一些限制，一旦达到这些限制，你就需要付费了。 要了解详情，请查看你的提供商的定价页面。
• 🟡 GitHub Pages 部署的工作流程设置起来可能很麻烦。 （不信的话，可以看看部署到 GitHub Pages 部分的长度！） 但是，这项服务（包括构建和部署）对所有公共仓库都永久免费，并且我们也有详细教程，帮助你正确运行它。

我需要多少服务端自定义？

• 🟢 自行托管时，你可以控制整个服务器的配置。 你可以配置虚拟主机，基于请求的 URL 来服务不同的内容；你可以去做复杂的服务端重定向；你可以实现鉴权…… 如果你需要很多服务器端功能，请选择自行托管网站。
• 🟡 Jamstack 通常提供一些服务端配置（像是 URL 格式（尾部斜杠）、服务端重定向等）。
• 🔴 GitHub Pages 不暴露任何服务端配置，除了强制使用 HTTPS 和设置 CNAME 记录。

我是否需要有利于协作的部署工作流？

• 🟡 自行托管服务可以利用持续部署功能，如 Netlify，但需要投入更大的精力。 通常，你将指定专人管理部署，而且相对于其他两个选项，它的工作流也不会非常基于 Git 。
• 🟢 Netlify 和 Vercel 对每个 Pull Request 都会生成部署预览，这对于在合并到生产环境之前的团队审核工作非常有用。 你也可以做团队管理，不同成员拥有不同的部署访问权限。
• 🟡 GitHub 页面不能做部署预览，至少方法非常复杂。 每个仓库只能和一个站点部署相关联。 另一方面，你还是可以控制哪些人有站点部署的写权限。

不存在通用方案。 你需要权衡你的需求和资源，然后再做决定。

自行托管

你可以用 docusaurus service 命令来自行托管 Docusaurus。 可以用 --port 和 --host 来分别更改端口和绑定主机。

npm

npm run serve -- --build --port 80 --host 0.0.0.0

Yarn

yarn serve --build --port 80 --host 0.0.0.0

pnpm

pnpm run serve --build --port 80 --host 0.0.0.0

警告

相较于其他静态托管提供商 / CDN，这不是最佳解决方案。

警告

在后面几节中，我们会介绍几个常用的托管提供商，以及如何做最有效的 Docusaurus 部署设置。 Docusaurus 不附属于这些服务里的任意哪家，提供这些信息只是出于便利性。 有些文章是由第三方提供的，最近的 API 更改可能不会在我们这里反映出来。 如果你发现了过时的内容，欢迎来提 PR。

由于我们只能在尽力而为的基础上提供此部分的内容，所以我们已经停止接受关于添加新托管选项的 PR。 不过你可以在其他网站上写一篇关于某个服务提供商的文章（比如你的博客，或者提供商官网），然后让我们添加一个这篇文章的链接。

部署到 Netlify

要把你的 Docusaurus 站点部署到 Netlify，请先确保正确配置下列选项：

docusaurus.config.js

export default {
  url: 'https://docusaurus-2.netlify.app', // 你的站点的 URL，不包含末尾斜杠
  baseUrl: '/', // 你的站点相对于仓库的基目录
  // ...
};

然后，用 Netlify 创建你的网站。

在设立站点时，指定如下构建指令和目录：

• 构建指令：npm run build
• 发布目录：build

如果你没有设置这些构建选项，你还是可以在创建站点之后前往 "Site settings" -> "Build & deploy" 完成配置。

用上述选项配置完毕后，你的网站就会在有代码合并到部署分支（默认为 main）时自动重新部署，

警告

某些 Docusaurus 网站把 docs 文件夹放在 website 之外（尤其是从 Docusaurus v1 迁移而来的站点）：

repo           # git 根目录
├── docs       # MD 文件
└── website    # Docusaurus 根目录

如果你选择用 website 文件夹作为 Netlify 的 base directory，那么更新 docs 时，Netlify 不会触发构建。你需要配置自定义 ignore 命令：

website/netlify.toml

[build]
  ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF . ../docs/"

警告

默认情况下，Netlify 会为 Docusaurus URL 添加末尾斜杠。

建议禁用 Netlify 的 Post Processing > Asset Optimization > Pretty Urls 设置，防止小写的 URL、不必要的重定向，以及 404 错误。

特别当心：Disable asset optimization 的全局选项不能正常工作，实际上并不会禁用 Pretty URLs 设置。 请确保单独取消勾选了 "Pretty URLs"。

如果你想保持开启 Pretty URLs Netlify 设置，就要适当配置 Docusaurus 的 trailingSlash 选项。

更多信息请参阅 slorber/trailing-slash-guide。

部署到 Vercel

部署 Docusaurus 项目到 Vercel 会带来多项收益，包括性能、易用性，等等。

要通过 Vercel 的 Git 集成部署你的 Docusaurus 项目，先确保项目已经被推送到了某个 Git 仓库中。

用 Import Flow 把项目导入进 Vercel。 在导入过程中，你会发现所有相关的选项都已帮你预配置好了；但你也可以选择变更这些选项中的任意选项。

项目导入完成后，所有分支的后续推送都会生成部署预览。所有生产分支（通常是 "main" 或 "master"）的变更都会触发生产部署。

部署到 GitHub Pages

Docusaurus 提供了一种简单的方法来发布到 GitHub Pages。每个 GitHub 仓库都免费附送了 Github Pages。

概览

通常，发布过程会涉及到两个仓库（至少是两个分支）：包含源文件的分支，以及包含将使用 Github Pages 提供（给用户）的构建输出的分支。 在下面的教程中，我们会把这两个仓库（分支）分别叫作源仓库（分支）和部署仓库（分支）。

每个 GitHub 仓库都关联有一个 GitHub Pages 服务。 如果部署仓库叫作 my-org/my-project（my-org 是组织名或用户名），那么网站会被部署在 https://my-org.github.io/my-project/ 处。 如果部署仓库叫做 my-org/my-org.github.io（组织的 GitHub Pages 仓库），则站点将被部署在 https://my-org.github.io/ 处。

信息

如果你需要为 GitHub Pages 自定义域名，可以在 static 目录中创建一个 CNAME 文件。 static 目录中的内容会在部署时被复制到 build 文件夹的根部。 使用自定义域名时，就可以把 baseUrl: '/projectName/' 改回 baseUrl: '/' 了，也可以把 url 设置成你的自定义域名。

你可以参阅 GitHub Pages 的关于 GitHub Pages 文档了解详情。

Github Pages 会从默认分支（一般是 master/main）或者 gh-pages 分支中提取部署文件（运行 docusaurus build 产生的文件）。文件可以放在根目录，也可以放在 /docs 目录中。 你可以在仓库的 Settings > Pages 处配置。 这个分支会被称作「部署分支」。

我们提供了 docusaurus deploy 命令，帮助你从源仓库部署到部署仓库，一步完成克隆、构建、提交。

docusaurus.config.js 设置

首先，修改你的 docusaurus.config.js，添加如下参数：

参数	描述
organizationName	拥有部署仓库的 GitHub 用户或组织。
projectName	部署仓库的名字。
deploymentBranch	部署分支的名称。 对于非组织的 Github Pages 仓库（projectName 不以 .github.io 为结尾），该参数默认为“gh-pages” 。 否则，它需要通过配置字段或环境变量显式定义。

这些字段也有对应的环境变量，它们的优先级要比字段自身更高：ORGANIZATION_NAME, PROJECT_NAME, 和 DEPLOYMENT_BRANCH。

警告

GitHub Pages 默认为 Docusaurus 网址链接添加末尾斜杠。 建议设置 trailingSlash（true 或 false 都可以，只要不是 undefined）。

示例：

docusaurus.config.js

export default {
  // ...
  url: 'https://endiliey.github.io', // 你的网站 URL
  baseUrl: '/',
  projectName: 'endiliey.github.io',
  organizationName: 'endiliey',
  trailingSlash: false,
  // ...
};

警告

默认情况下，GitHub Pages 会用 Jekyll 构建要被发布的文件。 因为 Jekyll 会忽略所有以 _ 开头的文件，所以我们推荐你在 static 文件夹中新建一个 .nojekyll 文件来禁用 Jekyll。

环境设置

参数	描述
USE_SSH	设置为 true 时，会用 SSH 而不是默认的 HTTPS 来连接到 GitHub 源仓库。 如果源仓库的地址是 SSH URL（比如 [email protected]:facebook/docusaurus.git），USE_SSH 会被推断为 true。
GIT_USER	用于推送部署文件的 GitHub 账户用户名，需要有部署仓库的推送权限。 对于你自己的仓库，这一般会是你自己的 GitHub 用户名。 不使用 SSH 时必填，使用 SSH 时则会被忽略。
GIT_PASS	GitHub 用户（GIT_USER 所指定）的 personal access token，用于非交互式部署（如持续部署）
CURRENT_BRANCH	源分支。 这个分支一般是 main 或 master，但它也可以是 gh-pages 之外的任何分支。 如果变量没有赋值，那么会使用 docusaurus deploy 被调用时的分支。
GIT_USER_NAME	向部署仓库推送时要使用的 git config user.name 值。
GIT_USER_EMAIL	向部署仓库推送时要使用的 git config user.email 值。

GitHub 企业安装版应该和 github.com 的工作方式一致。你只需要在环境变量中设置组织的 GitHub 企业主机即可。

参数	描述
GITHUB_HOST	你的 GitHub 企业网站的域名。
GITHUB_PORT	你的 GitHub 企业网站的端口。

部署

最后，要把你的网站部署到 GitHub Pages 上，请运行：

Bash

GIT_USER=<GITHUB_USERNAME> yarn deploy

Windows

cmd /C "set "GIT_USER=<GITHUB_USERNAME>" && yarn deploy"

PowerShell

cmd /C 'set "GIT_USER=<GITHUB_USERNAME>" && yarn deploy'

警告

从 2021 年 8 月开始，GitHub 要求每次命令行登录都使用个人访问令牌，而不是密码。 当 GitHub 提示你输入密码时，请输入个人访问令牌。 更多信息请见 GitHub 文档。

或者，你也可以使用 SSH (USE_SSH=true) 登录。

触发 GitHub Actions 部署

GitHub Actions 允许你在仓库中完成软件开发流程的自动化、自定义执行。

以下工作流示例假定你的网站源（文件）位于你仓库的 main 分支上（ _源分支_是 main 分支），而且你的发布源已经为使用自定义 GitHub Actions 工作流进行发布配置好了。

我们的目标是：

1. 当向 main 发起新的拉取请求时，有一个 action 确保网站构建成功，但不会真正部署。 这个 job 会被称为 test-deploy。
2. 当一个拉取请求被合并到 main 分支，或是某人直接向 main 分支推送时，站点会被构建并部署到 GitHub Pages。 这个 job 会被称为 deploy。

下面是两种通过 GitHub Actions 部署文档的方法。 根据你的部署仓库的位置，选择下面相应的选项卡：

• 源代码仓库和部署代码仓库是同一仓库。
• 部署仓库是一个远程仓库，和源仓库不同。 此方案的说明假定发布源为 gh-pages 分支。

同一

虽然你可以把两个 job 定义在同一个工作流文件中，但原始的 deploy 工作流总是会在 PR（拉取请求）的检查套件状态中被列为跳过，这不代表真实的状态，也不会为审查过程提供任何价值。 所以，我们建议把它们作为单独的工作流来管理。

GitHub action 文件

添加这两个工作流文件：

根据实际情况调整参数

这些文件假设你使用的是 Yarn。 如果你用的是 npm，需要把 cache: yarn、yarn install --frozen-lockfile、yarn build 分别修改成 cache: npm、npm ci、npm run build。

如果你的 Docusaurus 项目不在你的仓库的根目录，你可能需要配置默认工作目录，并相应地调整路径。

.github/workflows/deploy.yml

name: 部署到 GitHub Pages

on:
  push:
    branches:
      - main
    # 如果你想要进一步定义触发、路径以及其他内容，请检阅 Github Actions 文档
    # https://docs.github.com/zh/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
  build:
    name: 构建 Docusaurus
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-node@v4
        with:
          node-version: 18
          cache: yarn

      - name: 安装依赖
        run: yarn install --frozen-lockfile
      - name: 构建网站
        run: yarn build

      - name: 上传构建制品
        uses: actions/upload-pages-artifact@v3
        with:
          path: build

  deploy:
    name: 部署到 GitHub Pages
    needs: build

    # 给予 GITHUB_TOKEN 进行 Pages 部署所必须的权限
    permissions:
      pages: write # 以部署到 Pages
      id-token: write # 以验证部署来自恰当的源

    # 部署到 Github Pages 环境
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest
    steps:
      - name: 部署到 GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

.github/workflows/test-deploy.yml

name: 测试部署

on:
  pull_request:
    branches:
      - main
    # 如果你想要进一步定义触发、路径以及其他内容，请检阅 Github Actions 文档
    # https://docs.github.com/zh/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
  test-deploy:
    name: 测试部署
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-node@v4
        with:
          node-version: 18
          cache: yarn

      - name: 安装依赖
        run: yarn install --frozen-lockfile
      - name: 测试构建网站
        run: yarn build

远程

跨仓库的发布更难设置，因为你需要经过权限检查才能推送到另一仓库。 我们会使用 SSH 完成身份验证。

1. 生成一个新 SSH 密钥。 因为这个 SSH 密钥会用在 CI 中，所以不能输入任何密码。
2. 默认情况下，你的公钥应该会被创建在 ~/.ssh/id_rsa.pub 中。如果没有，那么在添加 GitHub 部署密钥时，要记得使用你在前一步中提供的名字。
3. 用 pbcopy < ~/.ssh/id_rsa.pub 把密钥复制到剪贴板，然后在你的部署仓库中，把它粘贴入部署密钥。 如果命令行不适合，可以手动复制文件内容。 在保存部署密钥之前，要勾选 Allow write access。
4. 你需要把你的私钥设置成 GitHub secret，从而允许 Docusaurus 为你运行部署。
5. 用 pbcopy < ~/.ssh/id_rsa 复制你的私钥，然后把它粘贴成一个 GitHub secret，名字叫 GH_PAGES_DEPLOY。 如果命令行不适合，可以手动复制文件内容。 保存你的 secret。
6. 在 .github/workflows/ 中创建你的文档工作流文件。 在此示例中，就是 deploy.yml。

至此，你应该已经：

• 通过把 SSH 私钥作为其 Github Secret，设置了具有 GitHub 工作流的源仓库
• 通过把 SSH 公钥添加到 GitHub 部署密钥中，设置了你的部署仓库

GitHub action 文件

警告

请确保将 [email protected] 替换为你的 GitHub 邮箱，并把 gh-actions 替换为你的名称。

此文件假定你使用的是 Yarn。 如果你用的是 npm，需要把 cache: yarn、yarn install --frozen-lockfile、yarn build 分别修改成 cache: npm、npm ci、npm run build。

.github/workflows/deploy.yml

name: 部署到 GitHub Pages

on:
  pull_request:
    branches: [main]
  push:
    branches: [main]

permissions:
  contents: write

jobs:
  test-deploy:
    if: github.event_name != 'push'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-node@v4
        with:
          node-version: 18
          cache: yarn
      - name: 安装依赖
        run: yarn install --frozen-lockfile
      - name: 测试构建网站
        run: yarn build
  deploy:
    if: github.event_name != 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-node@v4
        with:
          node-version: 18
          cache: yarn
      - uses: webfactory/ssh-[email protected]
        with:
          ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}
      - name: 部署到 GitHub Pages
        env:
          USE_SSH: true
        run: |
          git config --global user.email "[email protected]"
          git config --global user.name "gh-actions"
          yarn install --frozen-lockfile
          yarn deploy

网站没有正确部署？

在推送到 main 分支后，如果你没有看到你的站点被发布到想要的位置（比方说，访问后发现“这里没有 Github Pages 站点”，或是显示你仓库里的 README.md 文件），尝试以下步骤：

• 等3分钟，然后刷新一下。 GitHub 页面可能需要几分钟时间才能接收到新文件。
• 检查你仓库的入口页上次提交的标题旁是否有个绿色的小对勾。如果有，那就表明 CI 通过了。 如果你看到的是一个叉，那就说明构建或者部署失败了，你应该检查日志以获取更多调试信息。
• 点击对勾，确保你看到的是“部署到 Github Pages”工作流。 如果你看到的名称是类似“pages build and deployment / deploy”（即“页面构建和部署”）这样的，这就表明你的自定义部署工作流根本无法触发。 确保对应的 YAML 文件被放置在 .github/workflows 文件夹下，同时其触发条件也被正确设置了（比如，如果你的默认分支是“master”而不是“main”，你就需要修改 on.push 属性）。
• 在你仓库的 Settings > Pages 下，确保“Source”（其指的是用以_部署_的文件，不是我们术语里的“源（source）”）被设置为 “gh-pages” + “/(root)”，因为我们正在使用 gh-pages 作为部署分支。

如果你正在使用自定义域名：

• 如果你正在使用自定义域名，请验证你是否设置了正确的 DNS 记录。 请查看关于配置自定义域名的 GitHub pages 文档。 此外，请注意，DNS 修改可能需要24小时才能通过互联网传播（注：即 DNS 解析生效）。

触发 Travis CI 部署

持续集成（CI）服务通常用于每当新提交检入源代码控制（注：又称版本控制）时执行例程任务。 这些任务可以是运行单元测试、集成测试、自动化构建、发布包到 npm 和向你的网站部署变更的任意组合。 要自动化你网站的部署，你只需要每当站点更新时调用 yarn deploy 脚本。 下面的章节涵盖了如何使用 Travis CI 做到这一点。Travis CI 是一个热门的持续集成服务提供商。

1. 在 https://github.com/settings/tokens 上生成一个新 personal access token。 新建令牌时，授予它 repo 权限，这样它就有所有需要的权限了。
2. 用你的 GitHub 账户把 Travis CI 应用添加到你想要激活的仓库中。
3. 打开你的 Travis CI 主界面。 URL 大概像 https://travisenci.com/USERNAME/REPO，并导航到你的仓库的 More options > Setting > Environment Variables 部分。
4. 创建一个新环境变量，命名为 GH_TOKEN，值为你刚刚生成的令牌。再创建 GH_EMAIL 和 GH_NAME 两个变量，对应你的邮箱和 GitHub 用户名。
5. 在仓库根目录创建一个 .travis.yml 文件，包含下面的内容：

.travis.yml

language: node_js
node_js:
  - 18
branches:
  only:
    - main
cache:
  yarn: true
script:
  - git config --global user.name "${GH_NAME}"
  - git config --global user.email "${GH_EMAIL}"
  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
  - yarn install
  - GIT_USER="${GH_NAME}" yarn deploy

现在，每当有新的提交抵达 main，Travis CI 都将运行你的测试套件，之后如果所有测试通过，你的网站就会通过 yarn deploy 脚本被部署。

触发 Buddy 部署

Buddy 是一个易于使用的 CI/CD 工具，允许你将你的门户自动部署到不同的环境，包括 GitHub Pages。

按照以下步骤创建一个管道。每当你推送变更到项目中的选定分支时，它都会自动部署一份新版本的网站。

1. 在 https://github.com/settings/tokens 上生成一个新 personal access token。 新建令牌时，授予它 repo 权限，这样它就有所有需要的权限了。
2. 登录 Buddy 帐户并创建一个新项目。
3. 选择 GitHub 作为 git 托管提供商，并选择包含你的网站源码的仓库。
4. 在左侧的导航面板中，切换到 Pipelines 页面。
5. 创建一个新的管道。 输入一个名称，把触发模式设置为 On push，然后选择会触发管道执行的分支。
6. 添加一个 Node.js action。
7. 在 action 的终端中添加以下指令：

GIT_USER=<GH_PERSONAL_ACCESS_TOKEN>
git config --global user.email "<YOUR_GH_EMAIL>"
git config --global user.name "<YOUR_GH_USERNAME>"
yarn deploy

在创建了这一简单管道之后，每个新推送到你选定分支的提交，都会使用 yarn deploy 把你的网站部署到 GitHub Pages。 阅读这篇指南以了解更多关于为 Docusaurus 设置 CI/CD 管道的信息。

使用 Azure Pipelines

1. 如果你尚未注册，请在 Azure Pipelines 处注册。
2. 创建一个组织。 在组织内创建一个项目，连接到你的 GitHub 仓库。
3. 在 https://github.com/settings/tokens 上生成一个新 personal access token，包括 repo 权限。
4. 在项目页面（类似 https://dev.azure.com/ORG_NAME/REPO_NAME/_build），新建一个管道，包含如下文本。 点击编辑，创建一个新环境变量，命名为 GH_TOKEN，值为你刚刚生成的令牌。再创建 GH_EMAIL 和 GH_NAME 两个变量，对应你的邮箱和 GitHub 用户名。 确保把它们标记为私密。 或者，你也可以在仓库根目录添加一个 azure-pipelines.yml 文件。

azure-pipelines.yml

trigger:
  - main

pool:
  vmImage: ubuntu-latest

steps:
  - checkout: self
    persistCredentials: true

  - task: NodeTool@0
    inputs:
      versionSpec: '18'
    displayName: Install Node.js

  - script: |
      git config --global user.name "${GH_NAME}"
      git config --global user.email "${GH_EMAIL}"
      git checkout -b main
      echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
      yarn install
      GIT_USER="${GH_NAME}" yarn deploy
    env:
      GH_NAME: $(GH_NAME)
      GH_EMAIL: $(GH_EMAIL)
      GH_TOKEN: $(GH_TOKEN)
    displayName: Install and build

使用 Drone

1. 创建一个新的 SSH 密钥，它会是你的项目的部署密钥。
2. 命名你的私钥和公钥，确保它们不会覆盖其他 SSH 密钥。
3. 在 https://github.com/USERNAME/REPO/settings/keys 上，添加一个新部署密钥，把你刚刚生成的公钥粘贴进去。
4. 打开你的 Drone.io 界面并登录。 URL 看起来像 https://cloud.drone.io/USERNAME/REPO。
5. 点击仓库，点击激活仓库，并添加一个名为 git_depu_private_key 的秘密，值为你刚刚生成的私钥。
6. 在仓库根目录创建一个 .drone.yml 文件，包含下面的内容：

.drone.yml

kind: pipeline
type: docker
trigger:
  event:
    - tag
- name: Website
  image: node
  commands:
    - mkdir -p $HOME/.ssh
    - ssh-keyscan -t rsa github.com >> $HOME/.ssh/known_hosts
    - echo "$GITHUB_PRIVATE_KEY" > "$HOME/.ssh/id_rsa"
    - chmod 0600 $HOME/.ssh/id_rsa
    - cd website
    - yarn install
    - yarn deploy
  environment:
    USE_SSH: true
    GITHUB_PRIVATE_KEY:
      from_secret: git_deploy_private_key

现在，每当你推送新标签到 Github，此文件中的触发（trigger）都将启动 Drone CI 的 job，以发布你的网站。

部署到 Flightcontrol

Flightcontrol 是一个直接从你的 Git 仓库自动化构建 Web 应用程序，并将其部署到 AWS Fargate 的服务。 它给予你完全的控制权去检查和做出基础设施的变更，而无需遭受传统 PaaS 的限制。

请按照 Flightcontrol 的 Docusaurus 分步指南来开始使用它。

部署到 Koyeb

Koyeb 是一个开发者友好的无服务平台，它可以在全球范围内部署应用。 该平台通过基于 Git 的部署、原生的弹性伸缩、全球边缘网络，以及内置的服务网格和服务发现，允许你无缝地运行 Docker 容器、Web 应用和 API。 查看这篇 Koyeb 的 Docusaurus 部署指南来开始使用。

部署到 Render

Render offers free static site hosting with fully managed SSL, custom domains, a global CDN, and continuous auto-deploy from your Git repo. Get started in just a few minutes by following Render's guide to deploying Docusaurus.

Deploying to Qovery

Qovery is a fully-managed cloud platform that runs on your AWS, Digital Ocean, and Scaleway account where you can host static sites, backend APIs, databases, cron jobs, and all your other apps in one place.

1. 新建一个 Qovery 账户。 如果你还没有账户，可以在 Qovery 界面创建一个。
2. 新建一个项目。
   • 点击 Create project 并给你的项目命名。
   • 点击 Next。
3. 新建一个环境。
   • 点击 Create environment 并给它命名（比如 staging, production 等）。
4. 添加一个应用。
   • 点击 Create an application，给它命名，并选择你的 Docusaurus 应用所在的 GitHub 或 GitLab 仓库。
   • 定义主分支名称和应用的根目录。
   • 点击 Create。 应用创建完毕后：
   • 前往应用的 Settings
   • 选择 Port
   • 添加你的 Docusaurus 应用使用的端口
5. 部署
   • All you have to do now is to navigate to your application and click on Deploy.

That's it. Watch the status and wait till the app is deployed. To open the application in your browser, click on Action and Open in your application overview.

Deploying to Hostman

Hostman allows you to host static websites for free. Hostman automates everything, you just need to connect your repository and follow these easy steps:

1. Create a service.

   • To deploy a Docusaurus static website, click Create in the top-left corner of your Dashboard and choose Front-end app or static website.

2. Select the project to deploy.

   • If you are logged in to Hostman with your GitHub, GitLab, or Bitbucket account, you will see the repository with your projects, including the private ones.

   • Choose the project you want to deploy. It must contain the directory with the project's files (e.g. website).

   • To access a different repository, click Connect another repository.

   • If you didn't use your Git account credentials to log in, you'll be able to access the necessary account now, and then select the project.

3. Configure the build settings.

   • Next, the Website customization window will appear. Choose the Static website option from the list of frameworks.

   • The Directory with app points at the directory that will contain the project's files after the build. If you selected the repository with the contents of the website (or my_website) directory during Step 2, you can leave it empty.

   • The standard build command for Docusaurus is:

     npm

     npm run build

     Yarn

     yarn build

     pnpm

     pnpm run build

   • You can modify the build command if needed. You can enter multiple commands separated by &&.

4. Deploy.

   • Click Deploy to start the build process.

   • Once it starts, you will enter the deployment log. If there are any issues with the code, you will get warning or error messages in the log specifying the cause of the problem. Usually, the log contains all the debugging data you'll need.

   • When the deployment is complete, you will receive an email notification and also see a log entry. All done! Your project is up and ready.

Deploying to Surge

Surge is a static web hosting platform that you can use to deploy your Docusaurus project from the command line in seconds. Deploying your project to Surge is easy and free (including custom domains and SSL certs).

Deploy your app in a matter of seconds using Surge with the following steps:

1. First, install Surge using npm by running the following command:
   npm

   npm install -g surge

   Yarn

   yarn global add surge

   pnpm

   pnpm add -g surge
2. To build the static files of your site for production in the root directory of your project, run:
   npm

   npm run build

   Yarn

   yarn build

   pnpm

   pnpm run build
3. Then, run this command inside the root directory of your project:

   surge build/

First-time users of Surge would be prompted to create an account from the command line (which happens only once).

Confirm that the site you want to publish is in the build directory. A randomly generated subdomain *.surge.sh subdomain is always given (which can be edited).

使用自己的域名

If you have a domain name you can deploy your site using the command:

surge build/ your-domain.com

Your site is now deployed for free at subdomain.surge.sh or your-domain.com depending on the method you chose.

配置 CNAME 文件

Store your domain in a CNAME file for future deployments with the following command:

echo subdomain.surge.sh > CNAME

You can deploy any other changes in the future with the command surge.

Deploying to Stormkit

You can deploy your Docusaurus project to Stormkit, a deployment platform for static websites, single-page applications (SPAs), and serverless functions. For detailed instructions, refer to this guide.

Deploying to QuantCDN

1. Install Quant CLI
2. Create a QuantCDN account by signing up
3. Initialize your project with quant init and fill in your credentials:

   quant init
4. Deploy your site.

   quant deploy

See docs and blog for more examples and use cases for deploying to QuantCDN.

Deploying to Layer0

Layer0 is an all-in-one platform to develop, deploy, preview, experiment on, monitor, and run your headless frontend. It is focused on large, dynamic websites and best-in-class performance through EdgeJS (a JavaScript-based Content Delivery Network), predictive prefetching, and performance monitoring. Layer0 offers a free tier. Get started in just a few minutes by following Layer0's guide to deploying Docusaurus.

Deploying to Cloudflare Pages

Cloudflare Pages is a Jamstack platform for frontend developers to collaborate and deploy websites. Get started within a few minutes by following this article.

Deploying to Azure Static Web Apps

Azure Static Web Apps is a service that automatically builds and deploys full-stack web apps to Azure directly from the code repository, simplifying the developer experience for CI/CD. Static Web Apps separates the web application's static assets from its dynamic (API) endpoints. Static assets are served from globally-distributed content servers, making it faster for clients to retrieve files using servers nearby. Dynamic APIs are scaled with serverless architectures using an event-driven functions-based approach that is more cost-effective and scales on demand. Get started in a few minutes by following this step-by-step guide.

Deploying to Kinsta

Kinsta Static Site Hosting lets you deploy up to 100 static sites for free, custom domains with SSL, 100 GB monthly bandwidth, and 260+ Cloudflare CDN locations.

Get started in just a few clicks by following our Docusaurus on Kinsta article.