我的书签
添加书签
移除书签Docusaurus (2)
Last updated Oct 8, 2026 Start from CLI: Scaffold a Docusaurus project on Workers, and pick your template.
npmyarnpnpm
npm create cloudflare@latest -- my-docusaurus-app --framework=docusaurus
yarn create cloudflare my-docusaurus-app --framework=docusaurus
pnpm create cloudflare@latest my-docusaurus-app --framework=docusaurus
Or just deploy: Create a documentation site with Docusaurus and deploy it on Cloudflare Workers, with CI/CD and previews all set up for you.
What is Docusaurus?
Docusaurus ↗︎ is an open-source framework for building, deploying, and maintaining documentation websites. It is built on React and provides an intuitive way to create static websites with a focus on documentation.
Docusaurus is designed to be easy to use and customizable, making it a popular choice for developers and organizations looking to create documentation sites quickly.
Deploy a new Docusaurus project on Workers
- Create a new project with the create-cloudflare CLI (C3).npmyarnpnpm
npm create cloudflare@latest -- my-docusaurus-app --framework=docusaurus --platform=workers
yarn create cloudflare my-docusaurus-app --framework=docusaurus --platform=workers
pnpm create cloudflare@latest my-docusaurus-app --framework=docusaurus --platform=workers
<details><summary>
What's happening behind the scenes?</summary>
When you run this command, C3 creates a new project directory, initiates <a href="https://docusaurus.io/docs/installation">Docusaurus' official setup tool ↗︎</a>, and configures the project for Cloudflare. It then offers the option to instantly deploy your application to Cloudflare.</details>
- Develop locally.
After creating your project, run the following command in your project directory to start a local development server.npmyarnpnpm
npm run dev
yarn run dev
pnpm run dev
- Deploy your project.
Your project can be deployed to a *.workers.dev subdomain or a Custom Domain, from your local machine or any CI/CD system, (including Workers Builds).
Use the following command to build and deploy your project. If you're using a CI service, be sure to update your "deploy command" accordingly.npmyarnpnpm
npm run deploy
yarn run deploy
pnpm run deploy
Deploy an existing Docusaurus project on Workers
If you have a static site
If your Docusaurus project is entirely pre-rendered (which it usually is), follow these steps:
- Add a Wrangler configuration file.
In your project root, create a Wrangler configuration file with the following content:
jsonc
{
"name": "my-docusaurus-app",
// Update to today's date
// Set this to today's date
"compatibility_date": "2026-10-27",
"assets": {
"directory": "./build"
}
}
```toml name = "my-docusaurus-app" # Set this to today's date compatibility_date = "2026-10-27"
[assets] directory = "./build" ```
<details><summary>
What's this configuration doing?</summary>
The key part of this config is the <code>assets</code> field, which tells Wrangler where to find your static assets. In this case, we're telling Wrangler to look in the <code>./build</code> directory. If your assets are in a different directory, update the <code>directory</code> value accordingly. Refer to other <a href="https://developers.cloudflare.com/workers/static-assets/routing/">asset configuration options</a>.
Also note how there's no <code>main</code> field in this config - this is because you're only serving static assets, so no Worker code is needed for on demand rendering/SSR.</details>
- Build and deploy your project.
You can deploy your project to a *.workers.dev subdomain or a custom domain from your local machine or any CI/CD system (including Workers Builds). Use the following command to build and deploy. If you're using a CI service, be sure to update your "deploy command" accordingly.npmyarnpnpm
npx docusaurus build
yarn docusaurus build
pnpm docusaurus build
npmyarnpnpm
npx wrangler@latest deploy
yarn dlx wrangler@latest deploy
pnpx wrangler@latest deploy
Use bindings with Docusaurus
Bindings are a way to connect your Docusaurus project to other Cloudflare services, enabling you to store and retrieve data within your application.
With bindings, your application can be fully integrated with the Cloudflare Developer Platform, giving you access to compute, storage, AI and more.
Bindings
Access to compute, storage, AI and more.
Was this helpful?
YesNo
On this page
{"@context":"https://schema.org","@type":"TechArticle","@id":"https://developers.cloudflare.com/workers/framework-guides/web-apps/more-web-frameworks/docusaurus/#page","headline":"Docusaurus","description":"Create a Docusaurus application and deploy it to Cloudflare Workers with Workers Assets.","url":"https://developers.cloudflare.com/workers/framework-guides/web-apps/more-web-frameworks/docusaurus/","inLanguage":"en","image":"https://developers.cloudflare.com/workers/framework-guides/web-apps/more-web-frameworks/docusaurus/og.png?v=9a0498f6b16eeda6","dateModified":"2026-10-08","publisher":{"@type":"Organization","name":"Cloudflare","description":"One platform for your apps, agents, and workforce. Build, secure, and scale without managing infrastructure","url":"https://www.cloudflare.com/","sameAs":["https://github.com/cloudflare","https://www.linkedin.com/company/cloudflare","https://x.com/cloudflare"],"logo":{"@type":"ImageObject","url":"https://developers.cloudflare.com/logo.svg"},"address":{"@type":"PostalAddress","streetAddress":"101 Townsend St","addressLocality":"San Francisco","addressRegion":"CA","postalCode":"94107","addressCountry":"US"},"contactPoint":[{"@type":"ContactPoint","contactType":"Customer Support","url":"https://support.cloudflare.com/","availableLanguage":["English"]},{"@type":"ContactPoint","contactType":"Sales","url":"https://www.cloudflare.com/contact/","availableLanguage":["English"]}]},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"},"keywords":["ssg"]}
description: Create a Gatsby application and deploy it to Cloudflare Workers with Workers Assets. title: Gatsby image: https://developers.cloudflare.com/workers/framework-guides/web-apps/more-web-frameworks/gatsby/og.png?v=bad21e12227ec412
Documentation Index
Fetch the complete documentation index at: https://developers.cloudflare.com/workers/llms.txt
Use this file to discover all available pages before exploring further.
