跳转至主内容
Version: 2.0.0-beta.3

部署

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

npm run build

完成后,静态文件将生成于 build 目录中。

note

Docusaurus 仅仅负责构建并分发 build 文件夹中的静态文件。

现在,该由您来决定在何处进行托管了。

您可将您的网站部署到静态网站托管服务上,如 VercelGitHub PagesNetlifyRenderSurge 等。

Docusaurus 为静态渲染,而且通常情况下无需 JavaScript!

本地测试构建#

在部署到生产环境前,提前进行本地测试尤为重要。

Docusaurus includes a docusaurus serve command for that:

npm run serve

结尾斜杠配置#

Docusaurus 自带 trailingSlash 配置,让您能自定义 URL/链接和文件名格式。

您一般不需要进行修改。

但很遗憾,每家静态内容托管商均有所不同,而部署同一网站至不同的服务商可能会出现大相径庭的结果。

根据您的托管商的不同,您可能需要修改此配置。

tip

参见 slorber/trailing-slash-guide 来更好地了解您托管商的行为,并按需配置 trailingSlash 选项。

自己托管#

Docusaurus can be self-hosted using docusaurus serve. 使用 --port--host 来分别更改端口和绑定主机。

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

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

部署至 GitHub Pages#

Docusaurus 提供了轻松部署至 GitHub Pages 的方式。 每个 GitHub 仓库均自带此服务。

docusaurus.config.js 设置#

首先,修改您的 docusaurus.config.js 并添加如下必填参数:

参数描述
organizationName拥有此源的 GitHub 用户或组织。 若您是仓库所有者,这里则填写您的 GitHub 用户名。 对于 Docusaurus 而言,GitHub 组织 "facebook" 拥有 Docusaurus。
projectNameGitHub 源的名称。 举个例子,Docusaurus 的仓库名称是 "docusaurus",那么项目名称就是 "docusaurus"。
url您 GitHub Page 的用户/组织页面网址。 通常为:https://用户名.github.io。
baseUrl您站点的基准路径。 对于托管在 GitHub Pages 的项目而言,其遵循 "/项目名称/" 的格式。 对于 https://github.com/facebook/docusaurus 而言,其 baseUrl/docusaurus/
信息

如果您需要为 GitHub Pages 自定义域名,请在 static 目录中创建 CNAME 文件。 static 目录内的内容将在部署时复制到 build 文件夹的根目录。

使用自定义域名时,您应当将 baseUrl: '/项目名称/' 还原回 baseUrl: '/'

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

caution

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

示例:

docusaurus.config.js
module.exports = {  // ...  url: 'https://endiliey.github.io', // 您的网站网址  baseUrl: '/',  projectName: 'endiliey.github.io',  organizationName: 'endiliey',  trailingSlash: false,  // ...};
warning

默认情况下,GitHub Pages 通过 Jekyll 运行已发布的文件。 由于 Jekyll 忽略任意以 _ 开头的文件,所以我们推荐您在 static 文件夹中新建 .nojekyll 文件来禁用 Jekyll。

环境设置#

指定 Git 用户环境变量。

参数描述
GIT_USER拥有此仓库的提交权限之 GitHub 账户用户名。 对您自己的仓库而言,这通常也是您自己的 GitHub 用户名。 指定的 GIT_USER 参数必须拥有 organizationNameprojectName 的推送权限。

以下是可选参数,也请设置为环境变量:

参数描述
USE_SSHSet to true to use SSH instead of the default HTTPS for the connection to the GitHub repo.
DEPLOYMENT_BRANCHThe branch that the website will be deployed to, defaults to gh-pages. For GitHub Pages Organization repos (config.projectName ending in github.io), this env variable is required.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be main, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
GIT_PASSPassword (or token) of the git user (specified by GIT_USER). For example, to facilitate non-interactive deployment (e.g. continuous deployment)

GitHub enterprise installations should work in the same manner as github.com; you only need to set the organization's GitHub Enterprise host as an environment variable:

参数描述
GITHUB_HOSTThe domain name of your GitHub enterprise site.
GITHUB_PORTThe port of your GitHub enterprise site.

部署#

Finally, to deploy your site to GitHub Pages, run:

GIT_USER=<GITHUB_USERNAME> yarn deploy

触发 GitHub Actions 部署#

GitHub Actions allow you to automate, customize, and execute your software development workflows right in your repository. This workflow assumes your documentation resided in documentation branch of your repository and your publishing source is configured for gh-pages branch.

  1. Generate a new SSH key.
  2. By default, your public key should have been created in ~/.ssh/id_rsa.pub or use the name you've provided in the previous step to add your key to GitHub deploy keys.
  3. Copy key to clipboard with xclip -sel clip < ~/.ssh/id_rsa.pub and paste it as a deploy key in your repository. Copy file content if the command line doesn't work for you. 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 xclip -sel clip < ~/.ssh/id_rsa and paste a GitHub secret with name GH_PAGES_DEPLOY. Copy file content if the command line doesn't work for you. Save your secret.
  6. Create your documentation workflow file in .github/workflows/. In this example it's documentation.yml.
    warning

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

documentation.yml
name: documentation
on:  pull_request:    branches: [documentation]  push:    branches: [documentation]
jobs:  checks:    if: github.event_name != 'push'    runs-on: ubuntu-latest    steps:      - uses: actions/checkout@v1      - uses: actions/setup-node@v1        with:          node-version: '12.x'      - name: Test Build        run: |          if [ -e yarn.lock ]; then          yarn install --frozen-lockfile          elif [ -e package-lock.json ]; then          npm ci          else          npm i          fi          npm run build  gh-release:    if: github.event_name != 'pull_request'    runs-on: ubuntu-latest    steps:      - uses: actions/checkout@v1      - uses: actions/setup-node@v1        with:          node-version: '12.x'      - uses: webfactory/ssh-agent@v0.5.0        with:          ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}      - name: Release to GitHub Pages        env:          USE_SSH: true          GIT_USER: git        run: |          git config --global user.email "actions@github.com"          git config --global user.name "gh-actions"          if [ -e yarn.lock ]; then          yarn install --frozen-lockfile          elif [ -e package-lock.json ]; then          npm ci          else          npm i          fi          npm run deploy
  1. Now when a new pull request arrives towards your repository in branch documentation it will automatically ensure that Docusaurus build is successful.
  2. When pull request is merged to documentation branch or someone pushes to documentation branch directly it will be built and deployed to gh-pages branch.
  3. After this step, your updated documentation will be available on the GitHub pages.

触发 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. Open your Travis CI dashboard. 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_jsnode_js:  - '10'branches:  only:    - maincache:  yarn: truescript:  - 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 && 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. Sign in to your Buddy account and create a new project.
  3. Choose GitHub as your git hosting provider and select the repository with the code of your website.
  4. Using the left navigation panel, switch to the Pipelines view.
  5. Create a new pipeline. 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. Add these command in the action's terminal:
    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.

使用 Azure Pipelines#

  1. Sign Up at Azure Pipelines if you haven't already.
  2. Create an organization and within the organization create a project and connect your repository from 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). Make sure to mark them as secret. 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: '10.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 && GIT_USER="${GH_NAME}" yarn deploy    env:      GH_NAME: $(GH_NAME)      GH_EMAIL: $(GH_EMAIL)      GH_TOKEN: $(GH_TOKEN)    displayName: 'yarn install and build'

使用 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 our public key you just generated.
  4. Open your Drone.io dashboard and login. 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 below text.
# .drone.ymlkind: pipelinetype: dockertrigger:  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    - npm i    - npm run publish-gh-pages  environment:    USE_SSH: true    GIT_USER: $DRONE_COMMIT_AUTHOR    GITHUB_PRIVATE_KEY: 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.

部署至 Netlify#

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

docusaurus.config.js
module.exports = {  url: 'https://docusaurus-2.netlify.com', // Url to your site with no trailing slash  baseUrl: '/', // Base directory of your site relative to your repo  // ...};

Then, create your site with Netlify.

While you set up the site, specify the build commands and directories as follows:

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

If you did not configure these build options, you may still go to "Site settings" -> "Build and 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.

warning

By default, Netlify adds trailing slashes to Docusaurus URLs.

It is recommended to disable the Netlify setting Post Processing > Asset Optimization > Pretty Urls to prevent lowercased 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.

部署至 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, a list of which can be found here.

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

部署至 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, GCP, Azure and Digital Ocean account where you can host static sites, backend APIs, databases, cron jobs, and all your other apps in one place.

  1. Create a Qovery account.

Visit the Qovery dashboard to create an account if you don't already have one.

  1. Create a project

Click on "Create a new project" and give a name to your project.

Click on "Next".

  1. Add an application

Click on "Create an application" then choose "I have an application" and select your GitHub or GitLab repository where your app is located.

Click on "Next".

Skip adding services

  1. 部署

Click on "Deploy".

You can see the status in real time by clicking on deployment logs.

Deploying to Hostman#

Hostman allows you to host static websites for free. Hostman automates everything, you just need to connect your repository and follow 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.

  1. Select the project to deploy

If you are logged in to Hostman with your GitHub, GitLab or Bitbucket account, at this point 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 (usually it is website or my-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.

  1. 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. You can leave it empty if during Step 2 you selected the repository with the contents of the website (or my_website) directory.

The standard build command for Docusaurus will be:

yarn run build

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

  1. 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, but we are also here to help you solve the issues, so do not hesitate to contact us via chat.

When the deployment is complete, you will receive an e-mail notification and also see a log entry.

All done!

Your project is up and ready.

部署至 Surge#

Surge is a static web hosting platform, it is used to deploy your Docusaurus project from the command line in a minute. Deploying your project to Surge is easy and it is also free (including a custom domain and SSL).

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 install --g surge
  1. To build the static files of your site for production in the root directory of your project, run:
npm run build
  1. 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(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 surge to your domain using the command:

surge build/ yourdomain.com

Your site is now deployed for free at subdomain.surge.sh or yourdomain.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.

部署至 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
  1. 部署您的站点
quant deploy

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