//docs-examplesbyvicb

docs-examples

Examples surfaced in the Cloudflare Docs

0
0
0

docs-examples

This repo holds examples that are used in the Cloudflare docs (and it’s accompanying GitHub repo).

When to use

Use this repository when you want to use our GitHubCode component within the Cloudflare docs.

We choose to scope this component solely to repos within the cloudflare org for security reasons.

How to use

For any examples related to a specific product, create a new, top-level folder for that product.

Make sure you have the following files in your Worker:

  • .gitignore
  • package.json
  • wrangler.jsonc
  • Everything under src
  • worker-configuration.d.ts
  • tsconfig.json
  • static/README

Also, you should make your Worker using TypeScript. We can always detype to use JavaScript.

[beta]v0.13.0