Cloudflare Docs
Pages
Visit Pages on GitHub
Set theme to dark (⇧+D)

Deploy a Docusaurus site

Docusaurus is a static site generator. It builds a single-page application with fast client-side navigation, leveraging the full power of React to make your site interactive. It provides out-of-the-box documentation features but can be used to create any kind of site such as a personal website, a product site, a blog, or marketing landing pages.

​​ Install Docusaurus

To begin, with Node.js installed, create a new Docusaurus site by running:

$ npx [email protected] my-website classic

​​ Before you continue

All of the framework guides assume you already have a fundamental understanding of Git. If you are new to Git, refer to this summarized Git handbook on how to set up Git on your local machine.

If you clone with SSH, you must generate SSH keys on each computer you use to push or pull from GitHub.

Refer to the GitHub documentation and Git documentation for more information.

​​ Create a GitHub repository

Create a new GitHub repository by visiting repo.new. When creating your repository, do not select to add a README file, .gitignore template or a license as these selections will cause the push to GitHub to fail.

In your terminal, cd into your new Docusaurus project directory and run:

# Set up the local repository
$ git init
$ git remote add origin <YOUR_NEW_GITHUB_REPOSITORY_URL>
$ git branch -M main
# Commit all initial files
$ git add -A
$ git commit -m "<COMMIT_MESSAGE>"
# Send commit to new GitHub repository
$ git push -u origin main

You have successfully created a GitHub repository and pushed your Docusaurus project to that repository.

​​ Deploy with Cloudflare Pages

Deploy your site to Pages:

  1. Log in to the Cloudflare dashboard.
  2. In Account Home, select Pages > Create a project.
  3. Select the new GitHub repository that you created and, in the Set up builds and deployments section, select Docusaurus as your Framework preset. Your selection will provide the following information.
Configuration optionValue
Production branchmain
Build commandnpm run build
Build directorybuild
  1. Go to Environment variables (advanced) > Add variable > create a NODE_VERSION variable with a value of 16.

After deploying your site, you will receive a unique subdomain for your project on *.pages.dev.

Every time you commit new code to your Docusaurus site and push those changes to GitHub, Cloudflare Pages will automatically rebuild your project and deploy it. You will also get access to preview deployments on new pull requests and be able to preview how changes look to your site before deploying them to production.

For the complete guide to deploying your first site to Cloudflare Pages, refer to the Get started guide.

By completing this guide, you have successfully deployed your Docusaurus site to Cloudflare Pages. To get started with other frameworks, refer to the list of Framework guides.