Skip to content

🌥👷‍♀️ The documentation site for Cloudflare Workers

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

gfot/workers-docs

 
 

Repository files navigation

Cloudflare Workers Documentation

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

Install

Ensure you have the the following installed:

  • node version 10.13.0 or higher

Preview

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

cd workers-docs
yarn
yarn start

Your site is now running at http://localhost:8000!

Note: You'll also see a second link: http://localhost:8000/___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 autogenerated in ./public.

Worker

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

yarn worker-start

Build

To build all files to /public:

yarn build

To build all Worker files to worker-site/dist:

yarn worker-build

Test

To run test of the Workers script, run:

npm worker-test

What's inside

  1. cloudflare-docs-theme/: Gatsby theme, all the components for the docs

  2. workers-docs/: All the content and custom components for the Workers docs

Publishing

To publish to development environment (which is protected by access at dev.bigfluffycloudflare.com/workers) run:

yarn publish dev

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.

About

🌥👷‍♀️ The documentation site for Cloudflare Workers

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 61.4%
  • CSS 30.9%
  • JavaScript 7.7%