This project contains the static website content for the Cloudflare Workers documentation.
This project is broken down to two main folders:
cloudflare-docs-theme/: The engine that styles and runs the static build of the docs which is a Gatsby theme containing all the components for the docsworkers-docs/: All the content, custom components for the Workers docs, and the Worker Site that is the Worker code running on Cloudflaresrc/content: The content Markdown and MDX filessrc/*: custom components that add to and override components defined by thecloudflare-docs-themeworkers-site: the Worker Site that is the Worker code running on Cloudflare
Ensure you have the following installed:
If you're not making changes to the Gatsby theme, the simplest way to run the docs is by cd workers-doc and running the yarn commands. If changing the Gatsby theme then use yarn workspaces.
To test the content or static gatsby files locally, run:
cd workers-docs
yarn
yarn start
Your site is now running at http://localhost:1313
_Note: You'll also see a second link: http://localhost:1313/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial._
You can now edit the .md (./src/content) files and the HTML files will be automatically displayed in your browser.
To test the Worker logic serving these static files (i.e. anything in ./workers-site), run:
yarn worker-start
To build all files to workers-docs/public:
yarn build
To build all Worker files to workers-docs/worker-site/dist:
yarn worker-build
To run test of the Workers script, run:
yarn worker-test
To publish to development environment (which is protected by access at dev.bigfluffycloudflare.com/workers) run:
yarn publish dev
The Gatsby theme (code in cloudflare-docs-theme/) was designed to be published on NPM and reusable by other Cloudflare developer docs as well as consumed by any workspace in this repo (i.e. just Workers docs workers-docs) project in this repo. This way Workers docs can use the most updated (even if not published yet) shared theme, but can also custom the theme to Worker's specific styles and components.
yarn workspace cloudflare-workers-docs run $COMMAND
The command above will run whatever $COMMAND (e.g. yarn start, yarn publish dev, etc..) as listed above using the current theme is cloudflare-docs-theme and content/code in workers-docs.
For example
yarn workspace cloudflare-workers-docs run publish dev
Will build the static files using the source code of cloudflare-docs-theme and workers-docs then deploy the static files to the Worker site at dev.bigfluffycloudflare.com/workers
Upon a merge, the tip of the master branch is deployed by a GitHub Action to https://developers.cloudflare.com/workers/ .
This repo is overseen by the Cloudflare Workers team. Check out our contribution guide at CONTRIBUTING.md!
To contribute to templates see Template Contributing Guide.