mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00

History

jrandolf 416d56b033 chore: refactor `utils` (#9053 ) This PR - renames the `utils` folder to `tools` (follows internal practice), - migrates the contents of `scripts` into `tools` and removes scripts.		2022-10-06 10:27:14 +02:00
..
src/css	docs: sort and group sidebar items (#8940 )	2022-09-12 13:00:37 +02:00
static	chore: format docs (#8629 )	2022-07-05 15:41:43 +02:00
versioned_docs/version-18.2.0	chore: refactor `utils` (#9053 )	2022-10-06 10:27:14 +02:00
versioned_sidebars	chore: release main (#9052 )	2022-10-05 16:51:59 +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: use swc for building the website (#8941 )	2022-09-12 11:59:05 +00:00
package-lock.json	chore: update pin dependencies (#9050 )	2022-10-05 15:57:31 +02:00
package.json	chore: pin dependencies on pre-release (#9046 )	2022-10-05 15:05:50 +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: release main (#9052 )	2022-10-05 16:51:59 +02:00
versionsArchived.json	chore: release main (#9052 )	2022-10-05 16:51:59 +02:00

Website

This website is built using Docusaurus 2.

$ npm install

$ 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.

$ npm run build

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

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.