ChromeDevTools/debugger-protocol-viewer

debugger-protocol-viewer

Website for viewing Chrome DevTools Protocol defined at https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/public/devtools_protocol/.

More: DevTools Protocol repo and published DevTools Protocol website.

Building

# install dependencies
npm i

# regenerate the protocol files
npm run prep

# build it
npm run build

# serve it locally
npm run serve

Deploying

We deploy to https://chromedevtools.github.io/devtools-protocol/ despite the source living here. The repo/branch layout is described here. There is no need to manually trigger deployments. It’s done automatically as part of the devtools-protocol GitHub Actions workflow.

FYI: The protocol files here in debugger-protocol-viewer#master don't get updated. A deployment writes to the devtools-protocol#ghpages branch.

Adding new version

To add a new protocol version:

1. Modify pages/_data/versions.json
2. Create pages/_data/VERSION_SLUG.json
3. Create _versions/VERSION_SLUG.html file with protocol version description
4. Update the <div id="versions"> tag in pages/_includes/shell.hbs.
5. Build project

Adding new domains

Run npm run prep then node generate-sidenav-html.cjs and add into <div id="domains"> in pages/_includes/shell.hbs.

History

• v0.1 original Eric Guzman app.
• v0.2 irish's "upgrades".
• v0.8 guzman's polymer 0.8 refactor
• v1.0 konrad's polymer 1.0 + jekyll refactor
• v2.0 tim's polymer 2.0 - jekyll refactor
• v3.0 tim's Eleventy refactor
• which brings us to… now.

License

Apache

Contributing

Report issues about the website via GitHub issues in this repo. Please report issues with CDP itself via https://crbug.com/new. Pull requests very welcome!