# docs-examples

**Repository Path**: mirrors_cloudflare/docs-examples

## Basic Information

- **Project Name**: docs-examples
- **Description**: Examples surfaced in the Cloudflare Docs
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-29
- **Last Updated**: 2026-02-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# docs-examples

This repo holds examples that are used in the [Cloudflare docs](https://developers.cloudflare.com) (and it's accompanying [GitHub repo](https://github.com/cloudflare/cloudflare-docs)).

## When to use

Use this repository when you want to use our [GitHubCode](https://developers.cloudflare.com/style-guide/components/github-code/) 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.