puppeteer/website
release-please[bot] 1e0cb1a164
chore: release main (#10185)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2023-05-16 07:42:00 +00:00
..
src docs: fix website (#9935) 2023-03-29 11:37:35 +02:00
static chore: fix website URLs (#9490) 2023-01-11 15:51:39 +01:00
versioned_docs/version-20.2.1 chore: release main (#10185) 2023-05-16 07:42:00 +00:00
versioned_sidebars chore: release main (#10185) 2023-05-16 07:42:00 +00: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 chore: remove BrowserFetcher namespace (#10107) 2023-05-02 09:48:18 +02:00
package-lock.json docs: remove unhelpful api pages (#9933) 2023-03-28 18:02:00 +00:00
package.json docs: remove unhelpful api pages (#9933) 2023-03-28 18:02:00 +00:00
README.md feat: add documentation (#8593) 2022-07-01 11:52:39 +00:00
sidebars.js docs: website docs for browsers (#9986) 2023-04-06 14:23:10 +02:00
versions.json chore: release main (#10185) 2023-05-16 07:42:00 +00:00
versionsArchived.json chore: release main (#10185) 2023-05-16 07:42:00 +00: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.