Docusaurus
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.
Set up a new project
Use the create-cloudflare CLI (C3) to set up your project. C3 will create a new project directory, initiate Docusaurus’ official setup tool, and provide the option to deploy instantly.
To use create-cloudflare to create a new Docusaurus project, run the following command:
$ npm create cloudflare@latest my-docusaurus-app -- --framework=docusaurus
create-cloudflare will install additional dependencies, including the Wrangler CLI and any necessary adapters, and ask you setup questions.
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. After creating a new repository, go to your newly created project directory to prepare and push your local application to GitHub by running the following commands in your terminal:
$ git init
$ git remote add origin https://github.com/<your-gh-username>/<repository-name>
$ git add .
$ git commit -m "Initial commit"
$ git branch -M main
$ git push -u origin main
Deploy with Cloudflare Pages
Deploy via the create-cloudflare CLI (C3)
If you use create-cloudflare(C3) to create your new Docusaurus project, C3 will install all dependencies needed for your project and prompt you to deploy your project via the CLI. If you deploy, your site will be live and you will be provided with a deployment URL.
Deploy via the Cloudflare dashboard
- Log in to the Cloudflare dashboard and select your account.
- In Account Home, select Workers & Pages > Create application > Pages > Connect to Git.
- 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 option | Value |
|---|---|
| Production branch | main |
| Build command | npm run build |
| Build directory | build |
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.
Learn more
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.