Skip to content

Commit 2697abb

Browse files
committed
add docs
1 parent d52da17 commit 2697abb

File tree

2 files changed

+38
-2
lines changed

2 files changed

+38
-2
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,46 @@ If we require more information to address your pull request, the `more-informati
3333
- [npm](https://nodejs.org/en/learn/getting-started/an-introduction-to-the-npm-package-manager#introduction-to-npm) is the recommended package manager that must be used in installing dependencies.
3434
- The generated `package-lock.json` file must be committed to git.
3535

36+
## Wrangler config
37+
38+
If you're adding a code snippet to the docs that represents a Wrangler config file (`wrangler.toml` or `wrangler.json`) make sure you wrap it with the `<WranglerConfig>` component, which ensure it's rendered as both JSON and TOML e.g.
39+
40+
````
41+
42+
import { WranglerConfig } from "~/components";
43+
44+
<WranglerConfig>
45+
46+
```toml
47+
# Top-level configuration
48+
name = "my-worker"
49+
main = "src/index.js"
50+
compatibility_date = "2022-07-12"
51+
52+
workers_dev = false
53+
route = { pattern = "example.org/*", zone_name = "example.org" }
54+
55+
kv_namespaces = [
56+
{ binding = "<MY_NAMESPACE>", id = "<KV_ID>" }
57+
]
58+
59+
[env.staging]
60+
name = "my-worker-staging"
61+
route = { pattern = "staging.example.org/*", zone_name = "example.org" }
62+
63+
kv_namespaces = [
64+
{ binding = "<MY_NAMESPACE>", id = "<STAGING_KV_ID>" }
65+
]
66+
```
67+
68+
</WranglerConfig>
69+
70+
````
3671

3772
## Workers Playground
73+
3874
If you are adding a code snippet to the docs that is:
75+
3976
1. A fully contained, valid Worker (i.e. it does not require external dependencies or specific bindings)
4077
2. Only JavaScript
4178

@@ -58,6 +95,7 @@ export default {
5895
};
5996
```
6097
````
98+
6199
would render as
62100

63101
<img width="870" alt="Screenshot 2024-02-20 at 14 29 22" src="https://github.com/cloudflare/cloudflare-docs/assets/28503158/56aa8016-b3b6-4d64-8213-b1a26f16534a">

src/content/docs/workers/wrangler/configuration.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@ import { WranglerConfig } from "~/components";
2727

2828
<WranglerConfig>
2929

30-
<WranglerConfig>
31-
3230
```toml
3331
# Top-level configuration
3432
name = "my-worker"

0 commit comments

Comments
 (0)