- Notifications
You must be signed in to change notification settings - Fork7.2k
Cloudflare’s documentation
License
CC-BY-4.0, MIT licenses found
Licenses found
cloudflare/cloudflare-docs
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
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.
If you have any feedback for our documentation or are interested in contributing, please refer to ourcontribution guidelines.
You must have a recent version of Node.js (22+) installed. You may useVolta, a Node version manager, to install the latest version of Node andnpm
, which is a package manager that is included withnode
's installation.
$ curl https://get.volta.sh| bash$ volta install node@22
Install the Node.js dependencies for this project using npm or another package manager:
$ npm install
When making changes to the site, including any content changes, you may run a local development server by running the following command:
$ npm run dev
This spawns a server that will be accessible viahttp://localhost:1111
in your browser. Additionally, any changes made within the project – includingcontent/**
changes – will automatically reload your browser tab(s), allowing you to instantly preview your changes.
Our docs are deployed usingCloudflare Pages. Every commit pushed to production will automatically deploy todevelopers.cloudflare.com, and any pull requests opened will have a corresponding staging URL available in the pull request comments.
To get write access to this repo, please reach out to theDeveloper Docs room in chat.
Except as otherwise noted, Cloudflare and any contributors grant you a license to the Cloudflare Developer Documentation and other content in this repository under theCreative Commons Attribution 4.0 International Public License, see theLICENSE file, and grant you a license to any code in the repository under theMIT License, see theLICENSE-CODE file.
Cloudflare products and services referenced in the documentation may be either trademarks or registered trademarks of Cloudflare in the United States and/or other countries. The licenses for this project do not grant you rights to use any Cloudflare names, logos, or trademarks. Cloudflare's general trademark guidelines can be found athttps://www.cloudflare.com/trademark/.Cloudflare and any contributors reserve all other rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel, or otherwise.
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.
All commands are run from the root of the project, from a terminal:
Command | Action |
---|---|
npm install | Installs dependencies |
npm run dev | Starts local dev server atlocalhost:1111 |
npx astro build | Build your production site to./dist/ |
npm run astro -- --help | Get help using the Astro CLI |
Check outStarlight’s docs, readthe Astro documentation, or jump into theAstro Discord server.
About
Cloudflare’s documentation
Topics
Resources
License
CC-BY-4.0, MIT licenses found
Licenses found
Code of conduct
Security policy
Uh oh!
There was an error while loading.Please reload this page.