Repository files navigation

This site has been migrated to a new platform. As of 7 November, 2023, we stopped merging new pullrequests for updates to existing content. You can raise content issues in the newissue tracker,and they will be addressed on the migrated site.

developer.chrome.com is the ultimate resource for developers of all backgroundsto learn about what's new in Chrome!

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

If you're submitting a pull request to fix a bug, read theContributing guidelines.

Before you start writing take a moment to look over thedeveloper.chrome.com handbook andfamiliarize yourself with the process.

You'll need a recent version ofNode: v14 (LTS) or higher.To check your node version runnode -v in your terminal.

If you don't have node, or if you need to upgrade, we recommend using theNodeVersion Manager (nvm).

⚠️ If you'd like to contribute (and you're not a member of the core team), be sure to fork the repo first, and clone the fork.

git clone https://github.com/GoogleChrome/developer.chrome.com.git

npm ci

Building the entire site can take a while because it's over a thousand pages.If you want tomassively speed up your build times, we suggest setting somebuild flags to ignore certain sections.

WARNING: By default, in dev we ignore all translated docs (all docs outside of /en/ directory).To include them back, useELEVENTY_INCLUDE_TRANSLATED=true env variable.

• Create a.env file at the root of your project
• Optionally add the following:

# Ignore ALL /docs/ELEVENTY_IGNORE_DOCS=true# Only ignore /docs/android/ELEVENTY_IGNORE_ANDROID=true# Only ignore /docs/apps/ELEVENTY_IGNORE_APPS=true# Only ignore /docs/devtools/ELEVENTY_IGNORE_DEVTOOLS=true# Only ignore /docs/extensions/ELEVENTY_IGNORE_EXTENSIONS=true# Only ignore /docs/handbook/ELEVENTY_IGNORE_HANDBOOK=true# Only ignore /docs/lighthouse/ELEVENTY_IGNORE_LIGHTHOUSE=true# Only ignore /docs/multidevice/ELEVENTY_IGNORE_MULTIDEVICE=true# Only ignore /docs/native-client/ELEVENTY_IGNORE_NACL=true# Only ignore /docs/privacy-sandbox/ELEVENTY_IGNORE_PRIVACY_SANDBOX=true# Only ignore /docs/versionhistory/ELEVENTY_IGNORE_VERSIONHISTORY=true# Only ignore /docs/webstore/ELEVENTY_IGNORE_WEBSTORE=true# Only ignore /docs/workbox/ELEVENTY_IGNORE_WORKBOX=true# Ignore BLOG /blog/ELEVENTY_IGNORE_BLOG=true

To build only a specific component, start with the above.env file and change the value for thecomponent you wish to build. You can comment it out, or set it to0 orfalse.

npm run dev

Openhttp://localhost:8080/ to see the site locally. Changes to assets willrebuild the site. Refresh to see your changes.

Before you push your branch, find and address any errors.

npm run lint

To do a production build of the site and start the local serverrunnpm run production && npm start.

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

(Googlers only) If you would like to stage yourlocal changes to a unique URL,run the commandnpm run stage:personal. This can be useful if you're not readyto create a pull request yet, or if you need to stage something private.

☝️ You will need to be a member of our GCP project for this command to work.

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