部署

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

npm

npm run build

Yarn

yarn build

pnpm

pnpm run build

Once it finishes, the static files will be generated within the build directory.

备注

The only responsibility of Docusaurus is to build your site and emit static files in build.

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

You can deploy your site to static site hosting services such as Vercel, GitHub Pages, Netlify, Render, and Surge.

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

Configuration

The following parameters are required in docusaurus.config.js to optimize routing and serve files from the correct location:

参数	描述
url	站点 URL。 For a site deployed at https://my-org.com/my-project/, url is https://my-org.com/.
baseUrl	站点的 base URL，带有末尾斜杠。 For a site deployed at https://my-org.com/my-project/, baseUrl is /my-project/.

Testing your Build Locally

在部署到生产环境前，事先进行本地测试尤为重要。 Docusaurus provides a docusaurus serve command for that:

npm

npm run serve

Yarn

yarn serve

pnpm

pnpm run serve

By default, this will load your site at http://localhost:3000/.

Trailing slash configuration

Docusaurus has a trailingSlash config to allow customizing URLs/links and emitted filename patterns.

你一般不需要修改默认值。 Unfortunately, each static hosting provider has a different behavior, and deploying the exact same site to various hosts can lead to distinct results. 根据你的托管商的不同，你可能需要修改此配置。

提示

Use slorber/trailing-slash-guide to understand better the behavior of your host and configure trailingSlash appropriately.

Using environment variables

把可能敏感的信息放在环境变量中的做法很常见。 However, in a typical Docusaurus website, the docusaurus.config.js file is the only interface to the Node.js environment (see our architecture overview), while everything else (MDX pages, React components, etc.) are client side and do not have direct access to the process global variable. In this case, you can consider using customFields to pass environment variables to the client side.

docusaurus.config.js

// If you are using dotenv (https://www.npmjs.com/package/dotenv)
import 'dotenv/config';

export default {
  title: '...',
  url: process.env.URL, // You can use environment variables to control site specifics as well
  customFields: {
    // Put your custom environment here
    teamEmail: process.env.EMAIL,
  },
};

home.jsx

import useDocusaurusContext from '@docusaurus/useDocusaurusContext';

export default function Home() {
  const {
    siteConfig: {customFields},
  } = useDocusaurusContext();
  return <div>Contact us through {customFields.teamEmail}!</div>;
}

Choosing a hosting provider

有几种常见的托管选择：

• Self hosting with an HTTP server like Apache2 or Nginx.
• Jamstack providers (e.g. Netlify and Vercel). 我们会以它们为参考，但同样的道理也可以适用于其他提供商。
• GitHub Pages (by definition, it is also Jamstack, but we compare it separately).

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

How many resources (money, person-hours, etc.) am I willing to invest in this?

• 🔴 Self-hosting requires experience in networking as well as Linux and web server administration. It's the most difficult option, and would require the most time to manage successfully. Expense-wise, cloud services are almost never free, and purchasing/deploying an onsite server can be even more costly.
• 🟢 Jamstack 提供商可以帮助你建立一个运转良好的网站，几乎不需要时间，并且很容易配置功能，比如服务端重定向。 Many providers offer generous build-time quotas even for free plans that you would almost never exceed. However, free plans have limits, and you would need to pay once you hit those limits. 要了解详情，请查看你的提供商的定价页面。
• 🟡 GitHub Pages 部署的工作流程设置起来可能很麻烦。 (Evidence: see the length of Deploying to GitHub Pages!) 但是，这项服务（包括构建和部署）对所有公共仓库都永久免费，并且我们也有详细教程，帮助你正确运行它。

How much server-side customization do I need?

• 🟢 自行托管时，你可以控制整个服务器的配置。 You can configure the virtual host to serve different content based on the request URL, you can do complicated server-side redirects, you can implement authentication, and so on. 如果你需要很多服务器端功能，请选择自行托管网站。
• 🟡 Jamstack usually offers some server-side configuration (e.g. URL formatting (trailing slashes), server-side redirects, etc.).
• 🔴 GitHub Pages doesn't expose server-side configuration besides enforcing HTTPS and setting CNAME records.

Do I need collaboration-friendly deployment workflows?

• 🟡 Self-hosted services can leverage continuous deployment functionality like Netlify, but more heavy-lifting is involved. Usually, you would designate a specific person to manage the deployment, and the workflow wouldn't be very git-based as opposed to the other two options.
• 🟢 Netlify 和 Vercel 对每个 Pull Request 都会生成部署预览，这对于在合并到生产环境之前的团队审核工作非常有用。 你也可以做团队管理，不同成员拥有不同的部署访问权限。
• 🟡 GitHub 页面不能做部署预览，至少方法非常复杂。 每个仓库只能和一个站点部署相关联。 另一方面，你还是可以控制哪些人有站点部署的写权限。

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

Self-Hosting

Docusaurus can be self-hosted using docusaurus serve. Change port using --port and --host to change 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 is not affiliated with any of these services, and this information is provided for convenience only. Some of the write-ups are provided by third-parties, and recent API changes may not be reflected on our side. If you see outdated content, PRs are welcome.

Because we can only provide this content on a best-effort basis only, we have stopped accepting PRs adding new hosting options. 不过你可以在其他网站上写一篇关于某个服务提供商的文章（比如你的博客，或者提供商官网），然后让我们添加一个这篇文章的链接。

Deploying to Netlify

To deploy your Docusaurus sites to Netlify, first make sure the following options are properly configured:

docusaurus.config.js

export default {
  url: 'https://docusaurus-2.netlify.app', // Url to your site with no trailing slash
  baseUrl: '/', // Base directory of your site relative to your repo
  // ...
};

Then, create your site with Netlify.

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

• build command: npm run build
• publish directory: build

If you did not configure these build options, you may still go to "Site settings" -> "Build & deploy" after your site is created.

Once properly configured with the above options, your site should deploy and automatically redeploy upon merging to your deploy branch, which defaults to main.

注意

Some Docusaurus sites put the docs folder outside of website (most likely former Docusaurus v1 sites):

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

If you decide to use the website folder as Netlify's base directory, Netlify will not trigger builds when you update the docs folder, and you need to configure a custom ignore command:

website/netlify.toml

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

注意

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

It is recommended to disable the Netlify setting Post Processing > Asset Optimization > Pretty Urls to prevent lowercase URLs, unnecessary redirects, and 404 errors.

Be very careful: the Disable asset optimization global checkbox is broken and does not really disable the Pretty URLs setting in practice. Please make sure to uncheck it independently.

If you want to keep the Pretty Urls Netlify setting on, adjust the trailingSlash Docusaurus config appropriately.

Refer to slorber/trailing-slash-guide for more information.

Deploying to Vercel

Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.

To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.

Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options.

After your project has been imported, all subsequent pushes to branches will generate Preview Deployments, and all changes made to the Production Branch (usually "main" or "master") will result in a Production Deployment.

Deploying to GitHub Pages

Docusaurus provides an easy way to publish to GitHub Pages, which comes free with every GitHub repository.

Overview

Usually, there are two repositories (at least two branches) involved in a publishing process: the branch containing the source files, and the branch containing the build output to be served with GitHub Pages. In the following tutorial, they will be referred to as "source" and "deployment", respectively.

每个 GitHub 仓库都关联有一个 GitHub Pages 服务。 If the deployment repository is called my-org/my-project (where my-org is the organization name or username), the deployed site will appear at https://my-org.github.io/my-project/. If the deployment repository is called my-org/my-org.github.io (the organization GitHub Pages repo), the site will appear at https://my-org.github.io/.

信息

In case you want to use your custom domain for GitHub Pages, create a CNAME file in the static directory. Anything within the static directory will be copied to the root of the build directory for deployment. When using a custom domain, you should be able to move back from baseUrl: '/projectName/' to baseUrl: '/', and also set your url to your custom domain.

You may refer to GitHub Pages' documentation User, Organization, and Project Pages for more details.

GitHub Pages picks up deploy-ready files (the output from docusaurus build) from the default branch (master / main, usually) or the gh-pages branch, and either from the root or the /docs folder. You can configure that through Settings > Pages in your repository. 这个分支会被称作「部署分支」。

We provide a docusaurus deploy command that helps you deploy your site from the source branch to the deployment branch in one command: clone, build, and commit.

docusaurus.config.js settings

First, modify your docusaurus.config.js and add the following params:

参数	描述
organizationName	拥有部署仓库的 GitHub 用户或组织。
projectName	部署仓库的名字。
deploymentBranch	The name of the deployment branch. It defaults to 'gh-pages' for non-organization GitHub Pages repos (projectName not ending in .github.io). Otherwise, it needs to be explicit as a config field or environment variable.

These fields also have their environment variable counterparts which have a higher priority: ORGANIZATION_NAME, PROJECT_NAME, and DEPLOYMENT_BRANCH.

注意

GitHub Pages 默认为 Docusaurus 网址链接添加末尾斜杠。 It is recommended to set a trailingSlash config (true or false, not undefined).

示例：

docusaurus.config.js

export default {
  // ...
  url: 'https://endiliey.github.io', // Your website URL
  baseUrl: '/',
  projectName: 'endiliey.github.io',
  organizationName: 'endiliey',
  trailingSlash: false,
  // ...
};

注意

By default, GitHub Pages runs published files through Jekyll. Since Jekyll will discard any files that begin with _, it is recommended that you disable Jekyll by adding an empty file named .nojekyll file to your static directory.

Environment settings

参数	描述
USE_SSH	Set to true to use SSH instead of the default HTTPS for the connection to the GitHub repo. If the source repo URL is an SSH URL (e.g. git@github.com:facebook/docusaurus.git), USE_SSH is inferred to be true.
GIT_USER	The username for a GitHub account that has push access to the deployment repo. 对于你自己的仓库，这一般会是你自己的 GitHub 用户名。 不使用 SSH 时必填，使用 SSH 时则会被忽略。
GIT_PASS	Personal access token of the git user (specified by GIT_USER), to facilitate non-interactive deployment (e.g. continuous deployment)
CURRENT_BRANCH	源分支。 Usually, the branch will be main or master, but it could be any branch except for gh-pages. If nothing is set for this variable, then the current branch from which docusaurus deploy is invoked will be used.
GIT_USER_NAME	The git config user.name value to use when pushing to the deployment repo
GIT_USER_EMAIL	The git config user.email value to use when pushing to the deployment repo

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

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

Deploy

最后，要把你的网站部署到 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'

注意

Beginning in August 2021, GitHub requires every command-line sign-in to use the personal access token instead of the password. 当 GitHub 提示你输入密码时，请输入个人访问令牌。 See the GitHub documentation for more information.

Alternatively, you can use SSH (USE_SSH=true) to log in.

Triggering deployment with GitHub Actions

GitHub Actions allow you to automate, customize, and execute your software development workflows right in your repository.

The workflow examples below assume your website source resides in the main branch of your repository (the source branch is main), and your publishing source is configured for the gh-pages branch (the deployment branch is gh-pages).

我们的目标是：

1. When a new pull request is made to main, there's an action that ensures the site builds successfully, without actually deploying. This job will be called test-deploy.
2. When a pull request is merged to the main branch or someone pushes to the main branch directly, it will be built and deployed to the gh-pages branch. 在这之后，新的构建输出会被发布在 GitHub Pages 网站上。 This job will be called deploy.

下面是两种通过 GitHub Actions 部署文档的方法。 Based on the location of your deployment branch (gh-pages), choose the relevant tab below:

• Source repo and deployment repo are the same repository.
• The deployment repo is a remote repository, different from the source.

Same

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 indicative 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

添加这两个工作流文件：

Tweak the parameters for your setup

这些文件假设你使用的是 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

permissions:
  contents: write

jobs:
  deploy:
    name: Deploy to GitHub Pages
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 18
          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-pages@v3
        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.
          # You can swap them out with your own user credentials.
          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/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: yarn

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

Remote

A cross-repo publish is more difficult to set up because you need to push to another repo with permission checks. 我们会使用 SSH 完成身份验证。

1. Generate a new SSH key. 因为这个 SSH 密钥会用在 CI 中，所以不能输入任何密码。
2. By default, your public key should have been created in ~/.ssh/id_rsa.pub; otherwise, use the name you've provided in the previous step to add your key to GitHub deploy keys.
3. Copy the key to clipboard with pbcopy < ~/.ssh/id_rsa.pub and paste it as a deploy key in the deployment repository. 如果命令行不适合，可以手动复制文件内容。 Check the box for Allow write access before saving your deployment key.
4. You'll need your private key as a GitHub secret to allow Docusaurus to run the deployment for you.
5. Copy your private key with pbcopy < ~/.ssh/id_rsa and paste a GitHub secret with the name GH_PAGES_DEPLOY on your source repository. 如果命令行不适合，可以手动复制文件内容。 保存你的 secret。
6. Create your documentation workflow file in .github/workflows/. In this example it's deploy.yml.

At this point, you should have:

• the source repo with the GitHub workflow set with the private SSH key as the GitHub Secret, and
• your deployment repo set with the public SSH key in GitHub Deploy Keys.

GitHub action file

注意

Please make sure that you replace actions@github.com with your GitHub email and gh-actions with your name.

This file assumes 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.

.github/workflows/deploy.yml

name: Deploy to 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@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: yarn
      - name: Install dependencies
        run: yarn install --frozen-lockfile
      - name: Test build website
        run: yarn build
  deploy:
    if: github.event_name != 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: yarn
      - uses: webfactory/ssh-agent@v0.5.0
        with:
          ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}
      - name: Deploy to GitHub Pages
        env:
          USE_SSH: true
        run: |
          git config --global user.email "actions@github.com"
          git config --global user.name "gh-actions"
          yarn install --frozen-lockfile
          yarn deploy

Site not deployed properly?

After pushing to main, if you don't see your site published at the desired location (for example, it says "There isn't a GitHub Pages site here", or it's showing your repo's README.md file), try the following:

• Wait about three minutes and refresh. It may take a few minutes for GitHub pages to pick up the new files.
• Check your repo's landing page for a little green tick next to the last commit's title, indicating the CI has passed. If you see a cross, it means the build or deployment failed, and you should check the log for more debugging information.
• Click on the tick and make sure you see a "Deploy to GitHub Pages" workflow. Names like "pages build and deployment / deploy" are GitHub's default workflows, indicating your custom deployment workflow failed to be triggered at all. Make sure the YAML files are placed under the .github/workflows folder, and that the trigger condition is set correctly (e.g., if your default branch is "master" instead of "main", you need to change the on.push property).
• Under your repo's Settings > Pages, make sure the "Source" (which is the source for the deployment files, not "source" as in our terminology) is set to "gh-pages" + "/ (root)", since we are using gh-pages as the deployment branch.

If you are using a custom domain:

• Verify that you have the correct DNS records set up if you're using a custom domain. See GitHub pages documentation on configuring custom domains. Also, please be aware that it may take up to 24 hours for DNS changes to propagate through the internet.

Triggering deployment with Travis CI

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to npm, and deploying changes to your website. All you need to do to automate the deployment of your website is to invoke the yarn deploy script whenever your website is updated. The following section covers how to do just that using Travis CI, a popular continuous integration service provider.

1. Go to https://github.com/settings/tokens and generate a new personal access token. When creating the token, grant it the repo scope so that it has the permissions it needs.
2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
3. 打开你的 Travis CI 主界面。 The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
5. Create a .travis.yml on the root of your repository with the following:

.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

Now, whenever a new commit lands in main, Travis CI will run your suite of tests and if everything passes, your website will be deployed via the yarn deploy script.

Triggering deployment with Buddy

Buddy is an easy-to-use CI/CD tool that allows you to automate the deployment of your portal to different environments, including GitHub Pages.

Follow these steps to create a pipeline that automatically deploys a new version of your website whenever you push changes to the selected branch of your project:

1. Go to https://github.com/settings/tokens and generate a new personal access token. When creating the token, grant it the repo scope so that it has the permissions it needs.
2. 登录 Buddy 帐户并创建一个新项目。
3. 选择 GitHub 作为 git 托管提供商，并选择包含你的网站源码的仓库。
4. Using the left navigation panel, switch to the Pipelines view.
5. 创建一个新的管道。 Define its name, set the trigger mode to On push, and select the branch that triggers the pipeline execution.
6. Add a 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

After creating this simple pipeline, each new commit pushed to the branch you selected deploys your website to GitHub Pages using yarn deploy. Read this guide to learn more about setting up a CI/CD pipeline for Docusaurus.

Using Azure Pipelines

1. Sign Up at Azure Pipelines if you haven't already.
2. 创建一个组织。 在组织内创建一个项目，连接到你的 GitHub 仓库。
3. Go to https://github.com/settings/tokens and generate a new personal access token with the repo scope.
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. Also, click on edit and add a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username). 确保把它们标记为私密。 Alternatively, you can also add a file named azure-pipelines.yml at your repository root.

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

Using Drone

1. Create a new SSH key that will be the deploy key for your project.
2. Name your private and public keys to be specific and so that it does not overwrite your other SSH keys.
3. Go to https://github.com/USERNAME/REPO/settings/keys and add a new deploy key by pasting in the public key you just generated.
4. 打开你的 Drone.io 界面并登录。 The URL looks like https://cloud.drone.io/USERNAME/REPO.
5. Click on the repository, click on activate repository, and add a secret called git_deploy_private_key with your private key value that you just generated.
6. Create a .drone.yml on the root of your repository with the below text.

.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

Now, whenever you push a new tag to GitHub, this trigger will start the drone CI job to publish your website.

Deploying to Flightcontrol

Flightcontrol is a service that automatically builds and deploys your web apps to AWS Fargate directly from your Git repository. It gives you full access to inspect and make infrastructure changes without the limitations of a traditional PaaS.

Get started by following Flightcontrol's step-by-step Docusaurus guide.

Deploying to Koyeb

Koyeb is a developer-friendly serverless platform to deploy apps globally. The platform lets you seamlessly run Docker containers, web apps, and APIs with git-based deployment, native autoscaling, a global edge network, and built-in service mesh and discovery. Check out the Koyeb's Docusaurus deployment guide to get started.

Deploying to 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 账户。 Visit the Qovery dashboard to create an account if you don't already have one.
2. 新建一个项目。
   • Click on Create project and give a name to your project.
   • Click on Next.
3. 新建一个环境。
   • Click on Create environment and give a name (e.g. staging, production).
4. 添加一个应用。
   • Click on Create an application, give a name and select your GitHub or GitLab repository where your Docusaurus app is located.
   • 定义主分支名称和应用的根目录。
   • Click on Create. 应用创建完毕后：
   • Navigate to your application Settings
   • Select 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).

Using your domain

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.

Setting up CNAME file

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 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.