Skip to main content

デプロイ

本番用にウェブサイトの静的ファイルをビルドするには、次のコマンドを実行します。

npm run build

これが完了すると、静的ファイルがbuildディレクトリ内に生成されます。

メモ

Docusaurusの責任は、サイトをビルドし、build内に静的ファイルを生成することだけです。

これらの静的ファイルをどのようにホストするかは、あなた自身に委ねられます。

Vercel、GitHub Pages、Netlify、Render、Surgeなどの静的サイトホスティングサービスにサイトをデプロイすることができます。

Docusaurusのサイトは静的にレンダリングされ、一般的にJavaScriptなしで動作することができます！

設定​

ルーティングを最適化し、適切な場所からファイルを配信するために、docusaurus.config.jsで以下のパラメータが必要です。

名前説明
urlサイトのURLです。 https://my-org.com/my-project/にデプロイされたサイトの場合、urlはhttps://my-org.com/となります。
baseUrlプロジェクトのベースURLです。末尾にスラッシュを付けてください。 https://my-org.com/my-project/にデプロイされたサイトの場合、baseUrlは/my-project/となります。

ローカルでビルドをテスト​

ビルドを本番用にデプロイする前に、ローカルでテストすることは重要です。 Docusaurusはそのためにdocusaurus serveコマンドを用意しています。次のようにして実行できます。

npm run serve

初期設定では、http://localhost:3000でサイトを起動します。

末尾スラッシュの設定​

Docusaurusでは、URL/リンクやファイル名のパターンをカスタマイズするために、trailingSlash設定が用意されています。

一般的には初期設定値で問題なく動作します。 残念ながら、静的ホスティングプロバイダによって動作が異なるため、まったく同じサイトをさまざまなホストに展開すると、異なる結果になることがあります。 ホストによっては、この設定を変更することが有効な場合があります。

ヒント

slorber/trailing-slash-guideを利用してホストの挙動をよく理解し、trailingSlashを適切に設定するようにしてください。

環境変数の利用​

潜在的な機密情報を環境に置くことは、一般的に行われていることです。 しかし、一般的なDocusaurusのWebサイトでは、docusaurus.config.jsファイルがNode.js環境への唯一のインターフェースであり（アーキテクチャ概要を参照）、その他のもの（MDXページ、Reactコンポーネントなど）はクライアントサイドで、processグローバル変数に直接アクセスすることがありません。 この場合、customFieldsを使用して、環境変数をクライアント側に渡すことを検討することができます。

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>お問い合わせは{customFields.teamEmail}へお願いします。</div>;
}

ホスティングプロバイダーの選択​

一般的なホスティングオプションは以下に示す通りいくつかあります。

  • Apache2やNginxのようなHTTPサーバーを使ったセルフホスティング
  • Jamstackプロバイダー（NetlifyやVercelなど）。 ここではこれらを基準にしますが、他のプロバイダーでも同じ理屈が通用します。
  • GitHub Pages（定義上はJamstackでもありますが、ここでは分けて比較します）

どれを選ぶか迷ったら、以下の質問をしてみてください。

どれだけのリソース（お金・人手など）を投じられるか？

  • 🔴 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 providers can help you set up a working website in almost no time and offer features like server-side redirects that are easily configurable. 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 のデプロイワークフローは、設定に手間がかかることがあります。 （その証拠として、GitHub Pagesにデプロイの長さをご覧ください！） しかし、このサービス（ビルドとデプロイを含む）は公開リポジトリでは常に無料であり、私たちはそれをうまく機能させるための詳しい手順を用意しています。
サーバーサイドのカスタマイズはどの程度必要だろうか？
  • 🟢 セルフホストでは、サーバー全体の設定にアクセスすることができます。 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.
共同作業に適したデプロイワークフローは必要だろうか？
  • 🟡 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 には、すべてのプルリクエストに対してデプロイプレビューがあり、本番環境にマージする前にチームが作業を確認するのに便利です。 また、デプロイに対して異なるメンバーのアクセス権でチームを管理することもできます。
  • 🟡 GitHub Pages では、デプロイプレビューを非連続的に行うことはできません。 1つのリポジトリは1つのサイトのデプロイにしか関連付けることができません。 一方、サイトのデプロイへの書き込みアクセス権を持つ人を制御することができます。

銀の弾丸は存在しません。 自分のニーズとリソースを天秤にかけて、選択する必要があります。

セルフホスト​

Docusaurusはdocusaurus serveを使ってセルフホスティングすることができます。 ポートの変更は--portで、ホストの変更は--hostで行います。

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

静的ホスティングプロバイダー/CDNと比較すると、最良の選択肢とは言えません。

警告

以下の項目では、一般的なホスティングプロバイダをいくつか紹介し、Docusaurusサイトを最も効率的に展開するためにどのように設定すべきかを説明します。 Docusaurusははこれらのサービスとは一切関係なく、これらの情報はあくまで便宜上のために提供しているものです。 また、一部の記事は第三者によって提供されたものであり、最近のAPIの変更が反映されていない場合があります。 もし内容が古くなっているようでしたら、プルリクエストをお願いします。

本コンテンツはベストエフォートでしか提供できないため、新しいホスティングオプションを追加するプルリクエストの受付は停止しております。 ただし、別のサイト（例：あなたのブログやプロバイダーの公式サイト）であなたの記事を公開し、私たちにあなたの記事へのリンクを含めるように依頼することは可能です。

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
  // ...
};

次に、Netlifyでサイトを作成します。

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

  • 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 root
├── docs       # MD files
└── website    # Docusaurus root

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/"
警告

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

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.

GitHub Pagesへのデプロイ​

Docusaurusは、全てのGitHubリポジトリに無料で付属しているGitHub Pagesに公開する簡単な方法を提供しています。

概要​

通常、公開プロセスには2つのリポジトリ (少なくとも2つのブランチ) が関与しています。ソースファイルを含むブランチと、GitHub Pagesで配信するビルド出力を含むブランチです。 以下の説明では、それぞれ**「ソース」****「デプロイ（メント）」**と称します。

各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. This branch will be called the "deployment branch".

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の設定​

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

名前説明
organizationNameThe GitHub user or organization that owns the deployment repository.
projectNameThe name of the deployment repository.
deploymentBranchThe 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のURLにデフォルトで末尾にスラッシュを追加します。 trailingSlashの値を設定することを推奨します（trueまたはfalseのいずれか、undefinedは不可）。

例：

docusaurus.config.js
export default {
  // ...
  url: 'https://endiliey.github.io', // WebサイトのURL
  baseUrl: '/',
  projectName: 'endiliey.github.io',
  organizationName: 'endiliey',
  trailingSlash: false,
  // ...
};
警告

デフォルトでは、GitHub PagesはJekyllを介して公開ファイルを処理します。 Jekyllは_で始まるファイルを破棄するので、staticディレクトリに.nojekyllファイルという空のファイルを追加してJekyllを無効化することを推奨します。

環境設定​

名前説明
USE_SSHGitHubリポジトリへの接続にデフォルトのHTTPSではなくSSHを使用するにはtrueを設定します。 ソースリポジトリの URL が SSH URL（例：git@github.com:facebook/docusaurus.git）の場合、USE_SSHはtrueと推測されます。
GIT_USERデプロイメントリポジトリへのプッシュアクセス権を持つGitHubアカウントのユーザー名。 自分のリポジトリの場合、通常は自分のGitHubユーザー名になります。 SSHを使用しない場合に必須で、それ以外の場合は無視されます。
GIT_PASSPersonal access token of the git user (specified by GIT_USER), to facilitate non-interactive deployment (e.g. continuous deployment)
CURRENT_BRANCHThe source 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_NAMEThe git config user.name value to use when pushing to the deployment repo
GIT_USER_EMAILThe git config user.email value to use when pushing to the deployment repo

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_HOSTGitHubエンタープライズサイトのドメイン名。
GITHUB_PORTGitHubエンタープライズサイトのポート。

デプロイ​

最後に、次のコマンドを実行してGitHub Pagesにサイトをデプロイします。

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. When GitHub prompts for your password, enter the PAT instead. See the GitHub documentation for more information.

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

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 publishing with a custom GitHub Actions Workflow.

Our goal is that:

  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 GitHub Pages. This job will be called deploy.

Here are two approaches to deploying your docs with GitHub Actions. Based on the location of your deployment repository, 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. Instructions for this scenario assume publishing source is the gh-pages branch.

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 therefore propose to manage them as separate workflows instead.

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:
  build:
    name: Build 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: Install dependencies
        run: yarn install --frozen-lockfile
      - name: Build website
        run: yarn build

      - name: Upload Build Artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: build

  deploy:
    name: Deploy to GitHub Pages
    needs: build

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write # to deploy to Pages
      id-token: write # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4
.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@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-node@v4
        with:
          node-version: 18
          cache: yarn

      - name: Install dependencies
        run: yarn install --frozen-lockfile
      - name: Test build website
        run: yarn build
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:

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

Using Azure Pipelines​

  1. Sign Up at Azure Pipelines if you haven't already.
  2. Create an organization. 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: '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. Open your Drone.io dashboard and log in. 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. Create a Qovery account. Visit the Qovery dashboard to create an account if you don't already have one.
  2. Create a project.
    • Click on Create project and give a name to your project.
    • Click on Next.
  3. Create a new environment.
    • Click on Create environment and give a name (e.g. staging, production).
  4. Add an application.
    • Click on Create an application, give a name and select your GitHub or GitLab repository where your Docusaurus app is located.
    • Define the main branch name and the root application path.
    • Click on Create. After the application is created:
    • Navigate to your application Settings
    • Select Port
    • Add port used by your Docusaurus application
  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 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 install -g surge
  2. To build the static files of your site for production in the root directory of your project, run: 
    npm 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 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.