/workers-docs

🌥👷‍♀️ The documentation site for Cloudflare Workers

Primary LanguageHTMLApache License 2.0Apache-2.0

Cloudflare Workers Documentation

This project contains the static website content for the Cloudflare Workers documentation.

Install

Ensure you have the the following installed:

Preview

To test the content or static hugo files locally, run:

npm install
npm run start-hugo

You can now edit the .md files and the HTML files will be autogenerated.

To test the Worker logic serving these static files (i.e. anything in ./workers-site), run:

npm run start

Test

To run test of the Workers script, run:

npm test

Publishing

To publish to staging:

npm run publish staging

Releasing

Releasing done through CI for whatever is on master. Ask Ashley Williams or Kristian Freeman for questions.

Contributing

This repo is overseen by the Workers Developer Experience team. Check out our contribution guide at CONTRIBUTING.md!

To contribute to templates see Template Contributing Guide.