You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**[View the docs →](https://developers.cloudflare.com/)**
3
+
Welcome to the open-source repository for all [Cloudflare Developer Documentation](https://developers.cloudflare.com/).
4
4
5
-
## Why Cloudflare Docs is open source
5
+
Everyone, including those who are not part of the Cloudflare organization, are encouraged to contribute.
6
+
- If you are not a Cloudflare employee, learn how to contribute in the [contribution page](https://developers.cloudflare.com/style-guide/contributions/) of the Cloudflare Style Guide.
7
+
- If you are a Cloudflare employee, reach out via our Developer Docs space in Google chat.
6
8
7
-
Our documentation is open source so that we can stay connected with our community and quickly implement feedback. Whether you have opened an issue to provide feedback or contributed your own content, we thank you for helping us maintain quality documentation.
8
-
9
-
If you have any feedback for our documentation or are interested in contributing, please refer to our [contribution guidelines.](https://github.com/cloudflare/cloudflare-docs/blob/production/CONTRIBUTING.md)
10
-
11
-
## Setup
12
-
13
-
You must have a recent version of Node.js (22+) installed. You may use [Volta](https://github.com/volta-cli/volta), a Node version manager, to install the latest version of Node and `npm`, which is a package manager that is included with `node`'s installation.
14
-
15
-
```sh
16
-
$ curl https://get.volta.sh | bash
17
-
$ volta install node@22
18
-
```
19
-
20
-
Install the Node.js dependencies for this project using npm or another package manager:
21
-
22
-
```sh
23
-
$ npm install
24
-
```
25
-
26
-
## Development
27
-
28
-
When making changes to the site, including any content changes, you may run a local development server by running the following command:
29
-
30
-
```sh
31
-
$ npm run dev
32
-
```
33
-
34
-
This spawns a server that will be accessible via `http://localhost:1111` in your browser. Additionally, any changes made within the project – including `content/**` changes – will automatically reload your browser tab(s), allowing you to instantly preview your changes.
35
-
36
-
## Deployment
37
-
38
-
Our docs are deployed using [Cloudflare Pages](https://pages.cloudflare.com). Every commit pushed to production will automatically deploy to [developers.cloudflare.com](https://developers.cloudflare.com), and any pull requests opened will have a corresponding staging URL available in the pull request comments.
39
-
40
-
## For Cloudflare employees
41
-
42
-
To get write access to this repo, please reach out to the **Developer Docs** room in chat.
9
+
Thank you for helping us to maintain quality documentation.
43
10
44
11
## License and Legal Notices
45
12
@@ -49,19 +16,3 @@ Cloudflare products and services referenced in the documentation may be either t
49
16
Cloudflare and any contributors reserve all other rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel, or otherwise.
50
17
51
18
Please note that we may use AI tools to help us review technical documentation, pull requests and other issues submitted to our public GitHub page in order to identify and correct mistakes and other inconsistencies in our developer documentation. Please refrain from sharing any personal information in your submissions.
52
-
53
-
54
-
## 🧞 Commands
55
-
56
-
All commands are run from the root of the project, from a terminal:
|`npm run dev`| Starts local dev server at `localhost:1111`|
62
-
|`npx astro build`| Build your production site to `./dist/`|
63
-
|`npm run astro -- --help`| Get help using the Astro CLI |
64
-
65
-
## 👀 Want to learn more?
66
-
67
-
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
0 commit comments