https://github.com/puppeteer/pptr.dev

Puppeteer documentation website (old website for versions <=15.2.0)
https://github.com/puppeteer/pptr.dev

Last synced: 3 months ago
JSON representation

Puppeteer documentation website (old website for versions <=15.2.0)

• Host: GitHub
• URL: https://github.com/puppeteer/pptr.dev
• Owner: puppeteer
• License: apache-2.0
• Archived: true
• Created: 2018-05-08T16:08:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-08T08:09:57.000Z (almost 2 years ago)
• Last Synced: 2024-09-23T20:31:04.787Z (3 months ago)
• Language: JavaScript
• Homepage: https://puppeteer.github.io/pptr.dev
• Size: 538 KB
• Stars: 59
• Watchers: 15
• Forks: 19
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# https://pptr.dev

This repository contains source code for https://pptr.dev website.

## How it works

`pptr.dev` doesn't have any server side part. All the data is fetched dynamically from NPM and GitHub via XHRs.

On the first load, `pptr.dev`:

- fetches puppeteer releases from NPM

- fetches `docs/api.md` for every release

- caches all the loaded data locally

On a subsequent load, `pptr.dev` occasionally invalidates cached documentation and releases.

## Building and Running

1. To run debug version, use `npm run serve` and navigate browser to `http://localhost:8887`.

2. To run prod version, use `npm run build && npm run prod` and then navigate browser to `http://localhost:8888`

> **NOTE** Debug version of `pptr.dev` doesn't require any build steps; serving [`index.html`](https://github.com/GoogleChromeLabs/pptr.dev/blob/master/index.html) with any static server

is sufficient.

> **NOTE** Debug version of `pptr.dev` doesn't include service worker to simplify development

## Dependencies

- [commonmark.js](https://github.com/commonmark/commonmark.js/) is used to parse and render markdown documentation

- [idb-keyval](https://github.com/jakearchibald/idb-keyval) is used to work with IndexedDB

- [codemirror](http://codemirror.com/) is used to highlight code snippets inside markdown

## FAQ

#### Q: Does pptr.dev use Custom Elements?

No. `pptr.dev` creates HTML elements with descriptive names to make markup nicer; this approach works in old browsers as well.