To build the static files of your website for production, run:
Once it finishes, the static files will be generated within the
It is important to test build before deploying to a production. Docusaurus includes a
docusaurus serve command to test build locally.
It is not the most performant solution
Docusaurus can be self hosted using
docusaurus serve. Change port using
--host to change host.
Docusaurus provides an easy way to publish to GitHub Pages. Which is hosting that comes for free with every GitHub repository.
First, modify your
docusaurus.config.js and add the required params:
|The GitHub user or organization that owns the repository. If you are the owner, it is your GitHub username. In the case of Docusaurus, it is "facebook" which is the GitHub organization that owns Docusaurus.|
|The name of the GitHub repository. For example, the repository name for Docusaurus is "docusaurus", so the project name is "docusaurus".|
|URL for your GitHub Page's user/organization page. This is commonly https://_username_.github.io.|
|Base URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, |
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.
You may refer to GitHub Pages' documentation User, Organization, and Project Pages for more details.
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
Specify the Git user as an environment variable.
|The username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your GitHub username. The specified |
Optional parameters, also set as environment variables:
|Set to |
|The branch that the website will be deployed to, defaults to |
|The branch that contains the latest docs changes that will be deployed. Usually, the branch will be |
|Password (or token) of the |
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:
|The domain name of your GitHub enterprise site.|
|The port of your GitHub enterprise site.|
Finally, to deploy your site to GitHub Pages, run:
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
- Generate a new SSH key.
- By default, your public key should have been created in
~/.ssh/id_rsa.pubor use the name you've provided in the previous step to add your key to GitHub deploy keys.
- Copy key to clipboard with
xclip -sel clip < ~/.ssh/id_rsa.puband 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 accessbefore saving your deployment key.
- You'll need your private key as a GitHub secret to allow Docusaurus to run the deployment for you.
- Copy your private key with
xclip -sel clip < ~/.ssh/id_rsaand paste a GitHub secret with name
GH_PAGES_DEPLOY. Copy file content if the command line doesn't work for you. Save your secret.
- Create you documentation workflow file in
.github/workflows/. In this example it's
Please make sure that you replace
[email protected] with your GitHub email and
gh-actions with your name.
- Now when a new pull request arrives towards your repository in branch
documentationit will automatically ensure that Docusaurus build is successful.
- When pull request is merged to
documentationbranch or someone pushes to
documentationbranch directly it will be built and deployed to
- After this step, your updated documentation will be available on the GitHub pages.
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.
- Go to https://github.com/settings/tokens and generate a new personal access token. When creating the token, grant it the
reposcope so that it has the permissions it needs.
- Using your GitHub account, add the Travis CI app to the repository you want to activate.
- Open your Travis CI dashboard. The URL looks like
https://travis-ci.com/USERNAME/REPO, and navigate to the
Environment Variablessection of your repository.
- Create a new environment variable named
GH_TOKENwith your newly generated token as its value, then
GH_EMAIL(your email address) and
GH_NAME(your GitHub username).
- Create a
.travis.ymlon the root of your repository with the following:
Now, whenever a new commit lands in
master, Travis CI will run your suite of tests and if everything passes, your website will be deployed via the
yarn deploy script.
- Sign Up at Azure Pipelines if you haven't already.
- Create an organization and within the organization create a project and connect your repository from GitHub.
- Go to https://github.com/settings/tokens and generate a new personal access token with the
- In the project page (which looks like
https://dev.azure.com/ORG_NAME/REPO_NAME/_buildcreate a new pipeline with the following text. Also, click on edit and add a new environment variable named
GH_TOKENwith 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.ymlat your repository root.
- Create a new ssh key that will be the deploy key for your project.
- Name your private and public keys to be specific and so that it does not overwrite your other ssh keys.
- Go to
https://github.com/USERNAME/REPO/settings/keysand add a new deploy key by pasting in our public key you just generated.
- Open your Drone.io dashboard and login. The URL looks like
- Click on the repository, click on activate repository, and add a secret called
git_deploy_private_keywith your private key value that you just generated.
- Create a
.drone.ymlon the root of your repository with below text.
Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website.
To deploy your Docusaurus 2 sites to Netlify, first make sure the following options are properly configured:
While you set up the site, specify the build commands and directories as follows:
- build command:
npm run build
- build directory:
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
Make sure to disable Netlify setting
Pretty URLs to prevent lowercased URLs, unnecessary redirects and 404 errors.
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 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.
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.
- Create a Qovery account.
Visit the Qovery dashboard to create an account if you don't already have one.
- Create a project
Click on "Create a new project" and give a name to your project.
Click on "Next".
- 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
Click on "Deploy".
You can see the status in real time by clicking on deployment logs.
Hostman allows you to host static websites for free. Hostman automates everything, you just need to connect your repository and follow easy steps:
- 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.
- 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.
- 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:
You can modify the build command if needed. You can enter multiple commands separated by &&.
- 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.
Your project is up and ready.
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:
- First, install Surge using npm by running the following command:
- To build the static files of your site for production in the root directory of your project, run:
- Then, run this command inside the root directory of your project:
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:
Your site is now deployed for free at
yourdomain.com depending on the method you chose.
Store your domain in a CNAME file for future deployments with the following command:
You can deploy any other changes in the future with the command
Install Quant CLI
Create a QuantCDN account by signing up
Initialize your project with
quant initand fill in your credentials:
- Deploy your site