Deploy a Docusaurus site
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.
$ npx [email protected] my-website classic
Before you continue
Create a GitHub repository
Create a new GitHub repository by visiting . 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:
- Log in to the .
- In Account Home, select Pages > Create a project.
- 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.
- Go to Environment variables (advanced) > Add variable > create a
NODE_VERSIONvariable with a value of
After deploying your site, you will receive a unique subdomain for your project on
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 on new pull requests and be able to preview how changes look to your site before deploying them to production.