https://github.com/docschina/developer.chrome.com
持续翻译中
https://github.com/docschina/developer.chrome.com
Last synced: 3 months ago
JSON representation
持续翻译中
- Host: GitHub
- URL: https://github.com/docschina/developer.chrome.com
- Owner: docschina
- License: other
- Created: 2021-09-16T06:48:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-05T22:03:43.000Z (over 1 year ago)
- Last Synced: 2025-03-14T22:36:42.032Z (3 months ago)
- Language: HTML
- Homepage: https://chrome.jscn.org
- Size: 38.8 MB
- Stars: 7
- Watchers: 2
- Forks: 3
- Open Issues: 85
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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](https://github.com/GoogleChrome/developer.chrome.com/issues/new?assignees=&labels=bug&template=bug_report.md&title=) and a team member should reply shortly.
If you're submitting a pull request to fix a bug, read the
[Contributing guidelines](https://github.com/GoogleChrome/developer.chrome.com/blob/main/CONTRIBUTING.md).
## Authoring content ✍️
Before you start writing take a moment to look over the
[developer.chrome.com handbook](https://developer.chrome.com/docs/handbook) and
familiarize yourself with the process.
## Building the site 🏗
You'll need a recent version of [Node](https://nodejs.org/): 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)](https://github.com/nvm-sh/nvm).
### Clone the repo
⚠️ 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.
```bash
git clone https://github.com/GoogleChrome/developer.chrome.com.git
```
### Install dependencies
```bash
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:
```text
# 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
```bash
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.
```bash
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.
☝️ You will need to be a member of our GCP project for this command to work.
## 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.