Skip to content
master
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time

README.md

web.dev

Continuous integration

web.dev is the ultimate resource for developers of all backgrounds to learn, create, and solve on the web. It's meant to not only educate developers, but help them apply what they've learned to any site they work on, be it personal or business.

Found a bug? 👷‍♀️

Thanks for letting us know! Please file an issue and a team member should reply shortly.

Authoring content ✍️

Before you start writing take a moment to look over the web.dev handbook and familiarize yourself with the process. When you're ready, follow the steps in the Quickstart to create your content proposal.

Building the site 🏗

You'll need a recent version of Node: v12.10 or higher.

Clone the repo

git clone https://github.com/GoogleChrome/web.dev.git

Install dependencies

npm ci

Start a local server to preview the site

npm run dev

Open http://localhost:8080/ to see the site locally. Changes to assets will rebuild the site. Refresh to see your changes.

Speeding up builds

⚠️ This is an experimental feature 🧪🔬

Any change to the site will cause Eleventy to rebuild. This can take 10-20s. If you want to speed things up you can isolate your directory using the isolate command.

npm run isolate

This will move all of the markdown files for the site into the _exile directory and it will ignore them for builds.

You may pass an optional glob (or space separated list of globs) to the isolate command to tell it to preserve a directory.

# Example 1: Preserve the style-focus directory
# note the -- which is needed to pass options to npm scripts
npm run isolate -- src/site/content/en/accessible/style-focus/**

# Example 2: Preserve everything in the accessible directory
npm run isolate -- src/site/content/en/accessible/**/*

When you're finished making your edits, run the integrate command to restore all of the project files.

npm run integrate

☝️ A git commit hook will prevent you from being able to run git commit until you have run the integrate command.

Environments 🌳

Set ELEVENTY_ENV=prod to force production builds. This is the default when running "stage" or "deploy". No other options for ELEVENTY_ENV are supported, although our Eleventy site config will default to 'dev' if unspecified.

Staging 🕺

When you send in a pull request it will be automatically staged for you. Keep an eye out for the netlify bot to comment on the pull request with your unique URL.

Deploying the site 🚀

Automatic deploys

The site will build and deploy the master branch automatically every hour, Mon-Fri. If you've just merged an article then it should go live at the top of the next hour.

Manual deploys

To manually deploy the site you'll need to be a member of one of these GitHub teams:

  • @GoogleChrome/web-dev-admins
  • @GoogleChrome/web-dev-content
  • @GoogleChrome/web-dev-contributors
  • @GoogleChrome/web-dev-eng
  • @GoogleChrome/web-devrel
  1. Navigate to the Deploy workflow in the Actions panel.
  2. Click the Run workflow button. Make sure the branch says master, then click the green Run workflow button.

An expanded workflow popup with a green run workflow button inside of it.

Debugging 🐛

If you need to debug the site's build process:

  1. Add a debugger statement to .eleventy.js
  2. Run npm run debug
  3. Go to chrome://inspect to attach to the running process.

The Chrome inspect page showing the inspect button

You can’t perform that action at this time.