puppeteer/website
Alex Rudenko 1668d47b2f
docs: various doc improvements (#9396)
See commits for details.

Closes #1837, #5880, #7822, #8101, #8821, #9367, #9382, #9378, #4731
2022-12-09 13:57:39 +01:00
..
src/css docs: improve docs (#9179) 2022-10-28 08:49:28 +02:00
static chore: format docs (#8629) 2022-07-05 15:41:43 +02:00
versioned_docs/version-19.4.0 docs: fix documentation typo in Page.waitForSelector optional visible parameter (#9381) 2022-12-08 13:59:18 +01:00
versioned_sidebars chore: release main (#9322) 2022-12-07 19:35:29 +01: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: fix search bar (#9214) 2022-11-03 13:02:25 +01:00
package-lock.json docs: use algolia (#9208) 2022-11-03 09:40:12 +01:00
package.json docs: use algolia (#9208) 2022-11-03 09:40:12 +01:00
README.md feat: add documentation (#8593) 2022-07-01 11:52:39 +00:00
sidebars.js docs: various doc improvements (#9396) 2022-12-09 13:57:39 +01:00
versions.json chore: release main (#9322) 2022-12-07 19:35:29 +01:00
versionsArchived.json chore: release main (#9322) 2022-12-07 19:35:29 +01: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.