跳到主要内容
版本:2.0.0-beta.21

部署

要在生产环境中构建网站的静态文件,请运行:

npm run build

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

备注

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

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

你可以把你的网站部署到静态网站托管服务上,比如 VercelGitHub PagesNetlifyRenderSurge,等等。

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 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)
require('dotenv').config();

module.exports = {
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>;
}

选择托管服务商

有几种常见的托管选择:

  • 自行托管,通过 Apache2 或 Nginx 一类的 HTTP 服务器;
  • Jamstack 提供商,比如 NetlifyVercel。 我们会以它们为参考,但同样的道理也可以适用于其他提供商。
  • GitHub Pages。 (从定义上说,它也是 Jamstack,但我们会单独比较它。)

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

我愿意为此投入多少资源(时间和金钱)?
  • 🔴 自行托管是最难设置的——通常需要一个富有经验的人来管理。 云服务几乎永远不是免费的,而搭建一个本地服务器并把它连接到广域网可能更加昂贵。
  • 🟢 Jamstack 提供商可以帮助你建立一个运转良好的网站,几乎不需要时间,并且很容易配置功能,比如服务端重定向。 许多提供商的构建时间配额非常慷慨,甚至免费套餐也够用,你几乎永远不会超出配额。 然而它最终还是有限的——一旦达到限额,就需要付款。 要了解详情,请查看你的提供商的定价页面。
  • 🟡 GitHub Pages 部署的工作流程设置起来可能很麻烦。 (不信的话,可以看看部署到 GitHub Pages 部分的长度!) 但是,这项服务(包括构建和部署)对所有公共仓库都永久免费,并且我们也有详细教程,帮助你正确运行它。
我需要多少服务端配置?
  • 🟢 自行托管时,你可以控制整个服务器的配置。 你可以根据请求的 URL 配置虚拟主机提供不同的服务;你可以做复杂的服务端重定向;你可以把部分网站设置成认证后访问…… 如果你需要很多服务器端功能,请选择自行托管网站。
  • 🟡 Jamstack 通常会提供一些服务器端配置,比如 URL 格式化(是否带有末尾斜杠)、服务端重定向等。
  • 🔴 GitHub 页面除了使用 HTTPS 和设置 CNAME 以外,没有暴露任何服务器端的配置。
我是否需要团队协作?
  • 🟡 自行托管可以达到和 Netlify 一样的效果,但为此付出的工作要多得多。 通常,你会有一个特定的人负责部署,而且相比于其他两个选项,工作流程也不会非常基于 Git。
  • 🟢 Netlify 和 Vercel 对每个 Pull Request 都会生成部署预览,这对于在合并到生产环境之前的团队审核工作非常有用。 你也可以做团队管理,不同成员拥有不同的部署访问权限。
  • 🟡 GitHub 页面不能做部署预览,至少方法非常复杂。 每个仓库只能和一个站点部署相关联。 另一方面,你还是可以控制哪些人有站点部署的写权限。

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

自行托管

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

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

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

危险

在后面几节中,我们会介绍几个常用的托管提供商,以及如何做最有效的 Docusaurus 部署设置。 有些教程是由外部贡献者提供的。 Docusaurus 和任何服务都不利益相关。 文档可能不是最新的:服务提供商的后续 API 变更可能没有在本文档中有所反映。 如果你发现了过时的内容,欢迎提 PR。

鉴于同样的文档更新问题,我们不再接受添加新托管方案的 PR 了。 不过你可以在其他网站上写一篇关于某个服务提供商的文章(比如你的博客,或者提供商官网),然后让我们添加一个这篇文章的链接。

部署到 Netlify

要把 Docusaurus 2 站点部署到 Netlify,请先确保正确配置下列选项:

docusaurus.config.js
module.exports = {
url: 'https://docusaurus-2.netlify.app', // 你的网站的 URL,没有 末尾斜杠
baseUrl: '/', // 你的站点相对于仓库的路径
// ...
};

然后,用 Netlify 创建你的网站

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

  • 构建指令:npm run build
  • 构建目录:build

如果你没有设置这些构建选项,你还是可以在创建站点之后前往 "Site settings" -> "Build and 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

Github Pages 对所有 GitHub 仓库都免费。Docsaurus 提供了一个便捷的发布途径。

概览

通常发布过程会涉及两个仓库(至少是两个分支):包含源文件的分支,和包含要被部署到 GitHub Pages 上的构建输出的分支。 在下面的教程中,我们会把这两个仓库(分支)分别叫作源仓库(分支)部署仓库(分支)

每个 GitHub 仓库都关联有一个 GitHub Pages 服务。 如果部署仓库叫作 my-org/my-projectmy-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_NAMEPROJECT_NAMEDEPLOYMENT_BRANCH

注意

GitHub Pages 默认为 Docusaurus 网址链接添加末尾斜杠。 建议设置 trailingSlashtruefalse 都可以,只要不是 undefined)。

示例:

docusaurus.config.js
module.exports = {
// ...
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_PASSGitHub 用户(GIT_USER 所指定)的 personal access token,用于非交互式部署(如持续部署)
CURRENT_BRANCH源分支。 这个分支一般是 mainmaster,但它也可以是 gh-pages 之外的任何分支。 如果变量没有赋值,那么会使用 docusaurus deploy 被调用时的分支。

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

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

部署

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

GIT_USER=<GITHUB_USERNAME> yarn deploy
注意

从 2021 年 8 月开始,GitHub 要求每次命令行登录都使用个人访问令牌,而不是密码。 当 GitHub 提示你输入密码时,请输入个人访问令牌。 更多信息请见 GitHub 文档。 或者,你也可以使用 SSH (USE_SSH=true) 登录。

触发 GitHub Actions 部署

GitHub Actions 允许你在仓库中完成软件开发流程的自动化、自定义执行。 下面的工作流示例会假设你的网站源码在仓库的 main 分支(也就是源分支main),而发布源设置为 gh-pages 分支(也就是部署分支gh-pages)。 我们的目标是:

  1. 当向 main 发起新的拉取请求时,有一个 action 确保网站构建成功,但不会真正部署。 这个 job 会被称为 test-deploy
  2. 当一个拉取请求被合并到 main 分支,或直接向 main 分支推送时,站点会被构建并部署到 gh-pages 分支。 在这之后,新的构建输出会被发布在 GitHub Pages 网站上。 这个 job 会被称为 deploy。 下面是两种通过 GitHub Actions 部署文档的方法。 根据你的部署分支的位置 (gh-pages),选择相应的选项:
  • 源代码仓库和部署代码仓库是同一仓库。
  • 部署仓库是一个远程仓库,和源仓库不同。

While you can have both jobs defined in the same workflow file, the original deploy workflow will always be listed as skipped in the PR check suite status, which is not communicative of the actual status and provides no value to the review process. 所以,我们建议把它们作为单独的工作流来管理。

We will use a popular third-party deployment action: peaceiris/actions-gh-pages.

GitHub action files

Add these two workflow files:

Tweak the parameters for your setup

These files assume you are using yarn. If you use npm, change cache: yarn, yarn install --frozen-lockfile, yarn build to cache: npm, npm ci, npm run build accordingly.

If your Docusaurus project is not at the root of your repo, you may need to configure a default working directory, and adjust the paths accordingly.

.github/workflows/deploy.yml
name: Deploy to GitHub Pages

on:
push:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- uses: actions/setup-[email protected]
with:
node-version: 16.x
cache: yarn

- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Build website
run: yarn build

# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./build
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# 你可以用自己的用户信息替换它们。
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
.github/workflows/test-deploy.yml
name: Test deployment

on:
pull_request:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
test-deploy:
name: Test deployment
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- uses: actions/setup-[email protected]
with:
node-version: 16.x
cache: yarn

- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Test build website
run: yarn build

触发 Travis CI 部署

每次有新代码被提交到源码管理主机,一般都会有持续集成 (CI) 服务执行一些例行任务。 这些任务可能包括运行单元测试和集成测试、自动化构建、在 npm 上发布软件包、把改动发布到网站上,等等。 要自动化网站部署,你要做的所有工作就是在每次网站更新时调用 yarn deploy 脚本。 下面的部分所涉及的正是如何完成这一点,使用的是 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_EMAILGH_NAME 两个变量,对应你的邮箱和 GitHub 用户名。
  5. 在仓库根目录创建一个 .travis.yml 文件,包含下面的内容:
.travis.yml
language: node_js
node_js:
- '14.15.0'
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. In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build create a new pipeline with the following text. 点击编辑,创建一个新环境变量,命名为 GH_TOKEN,值为你刚刚生成的令牌。再创建 GH_EMAILGH_NAME 两个变量,对应你的邮箱和 GitHub 用户名。 确保把它们标记为私密。 或者,你也可以在仓库根目录添加一个 azure-pipelines.yml 文件。
azure-pipelines.yml
trigger:
- main

pool:
vmImage: ubuntu-latest

steps:
- checkout: self
persistCredentials: true

- task: [email protected]
inputs:
versionSpec: 14.x
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. Create a new ssh key that will be the deploy key for your project.
  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 上推送一个新标签时,都会触发 drone CI,并发布网站。

部署到 Koyeb

Koyeb 是一个开发者友好的无服务器平台,可以在全球部署应用。 此平台允许你无缝运行 Docker 容器、网页应用和 API,同时使用 Git、本机自动化、全球边缘网络、内置服务网格和发现。 可以查看 Koyeb 的 Docusaurus 部署指南开始上手。

部署到 Render

Render 提供了免费静态网站托管,提供完备的 SSL 管理、自定义域名、全球 CDN,和搭配 Git 仓库的持续自动部署。 跟随 Render 的 Docusaurus 部署指南,你可以在几分钟内上手。

部署到 Qovery

Qovery 是一个完全可管理的云平台,运行在 AWS、Digital Ocean、Scaleway 等平台上,你可以在同一个地方托管静态网站、 后端 API、数据库、cron job,和所有其他应用。

  1. 新建一个 Qovery 账户。 如果你还没有账户,可以在 Qovery 界面创建一个。
  2. 新建一个项目。
    • 点击 Create project 并给你的项目命名。
    • 点击 Next
  3. 新建一个环境。
    • 点击 Create environment 并给它命名(比如 staging, production 等)。
  4. 添加一个应用。
    • 点击 Create an application,给它命名,并选择你的 Docusaurus 应用所在的 GitHub 或 GitLab 仓库。
    • 定义主分支名称和应用的根目录。
    • 点击 Create。 应用创建完毕后:
    • 前往应用的 Settings
    • 选择 Port
    • 添加你的 Docusaurus 应用使用的端口
  5. 完成这些后,就只需要前往应用,然后点击 Deploy

部署应用

这样就完成了。 监视状态,直到应用部署完成。 要在浏览器中打开应用,在应用概览中点击 ActionOpen

部署到 Hostman

Hostman 允许你免费托管静态网站。 Hostman 会自动化所有东西,你只需要连接仓库并完成几个简单的步骤:

  1. 创建一个服务。

    要部署 Docusaurus 静态网站,点击主界面左上角的 Create,选择 Front-end app or static website

  2. 选择要部署的项目。

    如果你用 GitHub、GitLab 或 Bitbucket 账号登录 Hostman,你在这里就可以看见你的项目仓库,包括私有仓库。

    选择你要部署的项目。 它必须包含项目文件的目录(比如 website)。

    要访问另一个仓库,请点击 Connect another repository

    如果你没有用你的 Git 帐户登录,你现在也能访问必要的帐户,然后选择项目。

  3. 配置构建设置。

    接下来,会出现一个 Website customization 窗口。 在框架列表中,选择 Static website 选项。

    Directory with app 需要指向包含项目构建输出文件的目录。 如果在第 2 步中你选择了带有网站内容的仓库目录(比如 my_website),你可以将其留空。

    Docusaurus 的标准构建命令是:

    npm run build

    如果有需要,你可以修改构建命令。 你可以输入多个指令,用 && 分隔。

  4. 部署。

    点击 Deploy 开始构建进程。

    开始之后,你就会进入部署日志。 如果代码有任何问题,你会在日志中看到警告或错误信息,指明问题的原因。 通常,日志会包含你需要的所有调试数据。

    部署完成后,你会收到电子邮件通知,并且看到日志条目。 全部完成了! 你的项目已经就绪。

部署到 Surge

Surge 是一个静态网站托管平台,它可以在一分钟内通过命令行部署你的 Docusaurus 项目。 把你的项目部署到 Surge 很容易,同时也完全免费(包括自定义域名和 SSL)。

使用 surge 迅速部署你的应用,只需要完成以下步骤:

  1. 首先,运行以下命令通过 npm 安装 Surge:
    npm install -g surge
  2. 要在项目根目录生成生产构建的静态文件,运行:
    npm run build
  3. 然后,在项目的根目录运行以下指令:
    surge build/

Surge 的新用户会在命令行被提示创建账户(只会发生一次)。

确认你要发布的站点已经在 build 目录中, Surge 会提供一个随机生成的子域名 *.surge.sh(后续可以编辑)。

使用自己的域名

如果你有域名,你可以通过如下指令,使用 surge 把网站部署到你的域名:

surge build/ your-domain.com

你的网站现在被免费部署在了 subdomain.surge.shyour-domain.com 上,取决于你选择的方式。

配置 CNAME 文件

使用以下命令把你的域名存储在 CNAME 文件中,以供未来部署:

echo subdomain.surge.sh > CNAME

以后,你可以通过 surge 命令部署任何其他更改。

部署到 QuantCDN

  1. 安装 Quant CLI
  2. 注册一个 QuantCDN 帐户
  3. quant init 初始化你的项目,并填写你的账号信息:
    quant init
  4. 部署网站。
    quant deploy

要查看 QuantCDN 部署的更多示例和使用场景,可以参阅 QuantCDN 的文档博客

部署到 Layer0

Layer0 是一个可以开发、部署、预览、实验、监视和运行无头前端的万能平台。 它侧重于大型动态网站,通过 EdgeJS(一个基于 JavaScript 的内容分发网络)、预测性预抓取和性能监测,最大化提升性能。 Layer0 提供免费服务。 跟随 Layer0 的 Docusaurus 部署指南,你可以在几分钟内上手。

部署到 Cloudflare Pages

Cloudflare Pages 是一个 Jamstack 平台,允许前端开发者协作并部署网站。 这篇文章能带你在几分钟内上手。

部署到 Azure Static Web Apps

Azure Static Web Apps 服务允许你直接将全栈网络应用从代码仓库自动构建部署到 Azure,大大简化 CI/CD 的开发者体验。 Static Web Apps 会将网络应用的静态资源和动态 API 端点分离开来。 静态资源是从全球分布的内容服务器分发的,允许客户端通过附近的服务器更快地获取文件。 动态 API 使用无服务器架构,事件驱动,以函数为基础,更具成本效益,并能根据需要缩放。 这个手把手指南能带你在几分钟内上手。