To build the static files of your website for production, run:
Once it finishes, you should see the production build under the
Deploying to ZEIT Now
Most importantly, however, deploying a Docusaurus project only takes a couple seconds:
- First, install their command-line interface:
- Run a single command inside the root directory of your project:
That's all. Your docs will automatically be deployed.
Deploying to GitHub Pages
Docusaurus provides a easy way to publish to GitHub Pages.
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.
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 |
There are two more optional parameters that are set as environment variables:
|Set to |
|The branch that contains the latest docs changes that will be deployed. Usually, the branch will be |
Finally, to deploy your site to GitHub Pages, run:
Deploying to Netlify
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
Deploying to Render
Render offers free static site hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploys from your Git repo. Deploy your app in just a few minutes by following these steps.
Create a new Web Service on Render, and give Render permission to access your Docusaurus repo.
Select the branch to deploy. The default is
Enter the following values during creation.
Field Value Environment
That's it! Your app will be live on your Render URL as soon as the build finishes.