puppeteer/website
release-please[bot] e2d9858b38
chore(main): release 17.0.0 (#8828)
* chore(main): release 17.0.0

* chore: generate versioned docs

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2022-08-29 11:11:05 +02:00
..
src/css chore: format code (#8628) 2022-07-05 15:06:10 +02:00
static chore: format docs (#8629) 2022-07-05 15:41:43 +02:00
versioned_docs/version-17.0.0 chore(main): release 17.0.0 (#8828) 2022-08-29 11:11:05 +02:00
versioned_sidebars chore(main): release 17.0.0 (#8828) 2022-08-29 11:11:05 +02:00
archive.js chore: remove old website versions and point to md docs instead (#8757) 2022-08-09 11:13:05 +00:00
babel.config.js feat: add documentation (#8593) 2022-07-01 11:52:39 +00:00
docusaurus.config.js docs: introduce the Guides section + restore req interception docs (#8758) 2022-08-09 12:01:23 +00:00
package-lock.json chore: add custom rule for formatting comments (#8777) 2022-08-12 14:15:26 +02:00
package.json chore: add custom rule for formatting comments (#8777) 2022-08-12 14:15:26 +02:00
README.md feat: add documentation (#8593) 2022-07-01 11:52:39 +00:00
sidebars.json feat: add documentation (#8593) 2022-07-01 11:52:39 +00:00
versions.json chore(main): release 17.0.0 (#8828) 2022-08-29 11:11:05 +02:00
versionsArchived.json chore(main): release 17.0.0 (#8828) 2022-08-29 11:11:05 +02:00

Website

This website is built using Docusaurus 2.

Installation

$ npm install

Local Development

$ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true npm run deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.