search

ChromeDevTools / debugger-protocol-viewer

DevTools Protocol API docs—its domains, methods, and events
https://chromedevtools.github.io/devtools-protocol/
Other
862 stars 173 forks source link
chrome-debugging-protocol chrome-devtools

readme

devtools-protocol

Explore the Chrome DevTools Protocol, its methods, events and basic documentation.

More: DevTools Protocol repo and published devtools protocol viewer

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.js and add into <div id="domains"> in pages/_includes/shell.hbs.

History

License

Apache

Contributing

Pull requests very welcome!