Skip to content

Latest commit

 

History

History
80 lines (49 loc) · 3 KB

README.md

File metadata and controls

80 lines (49 loc) · 3 KB
Raw

Cloudflare Workers Documentation

This project contains the static website content for the Cloudflare Workers documentation.

Install

Ensure you have the the following installed:

Preview

To test the content or static gatsby files locally, run:

npm install
npm run start

Your site is now running at http://localhost:8000!

Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

You can now edit the .md (/src/content)files and the HTML files will be autogenerated in ./public.

Worker

To test the Worker logic serving these static files (i.e. anything in ./workers-site), run:

npm run worker-start

Build

To build all files to /public:

npm run build

To build all Worker files to worker-site/dist:

npm run worker-build

Test

To run test of the Workers script, run:

npm worker-test

What's inside

  1. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.

  2. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

  3. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

  4. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

  5. gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.

Publishing

To publish to development environment (which is protected by access at dev.bigfluffycloudflare.com/workers) run:

npm run publish dev

Releasing

Releasing done through CI for whatever is on master. Ask Ashley Williams or Kristian Freeman for questions.

Contributing

This repo is overseen by the Workers Developer Experience team. Check out our contribution guide at CONTRIBUTING.md!

To contribute to templates see Template Contributing Guide.