developer.chrome.com
developer.chrome.com is the ultimate resource for developers of all backgrounds to learn about what's new in Chrome!
👷♀️
Found a bug? 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 the Contributing guidelines.
✍️
Authoring content Before you start writing take a moment to look over the developer.chrome.com handbook and familiarize yourself with the process.
🏗
Building the site You'll need a recent version of Node: v14 (LTS) or higher.
To check your node version run node -v
in your terminal.
If you don't have node, or if you need to upgrade, we recommend using the Node Version Manager (nvm).
Clone the repo
git clone https://github.com/GoogleChrome/developer.chrome.com.git
Install dependencies
npm ci
Set up build flags
Building the entire site can take a while because it's over a thousand pages. If you want to massively speed up your build times, we suggest setting some build 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, use ELEVENTY_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 the
component you wish to build. You can comment it out, or set it to 0
or false
.
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.
Run linters to address bugs
Before you push your branch, find and address any errors.
npm run lint
🌳
Environments To do a production build of the site and start the local server
run npm run production && npm start
.
🕺
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.
(Googlers only) If you would like to stage your local changes to a unique URL,
run the command npm run stage:personal
. This can be useful if you're not ready
to create a pull request yet, or if you need to stage something private.
🚀
Deploying the site Automatic deploys
The site will build and deploy the main
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.