Explore the Chrome DevTools Protocol, its methods, events and basic documentation.
More: DevTools Protocol repo and published devtools protocol viewer
Dependencies:
bundle install
bower install
Building:
# compiles site to _site/ and watches for file changes
bundle exec jekyll server --incremental
# always use `bundle exec` to use the local version of jeykyll
Generate latest up-to-date docs:
./generate-docs.sh
# to build (although gh-pages will do it on its own)..
bundle exec jekyll build
Deploying:
We deploy to https://chromedevtools.github.io/devtools-protocol/ despite the source living here. The repo/branch layout is described here.
# deploy to https://chromedevtools.github.io/devtools-protocol/
git remote add dtprotocol [email protected]:ChromeDevTools/devtools-protocol.git
git push dtprotocol master:gh-pages
All pushes to gh-pages instantly trigger a jeklyll build and the site will serve the resulting _site
.
To add a new protocol version:
- Modify
_data/versions.json
- Create
_data/VERSION_SLUG
folder and putprotocol.json
file there - Create
_versions/VERSION_SLUG.html
file with protocol version description - Build project
- 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
- which brings us to… now.
Apache
Pull requests very welcome!