github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
f07ad2c661
puppeteer/website
History
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer (#9150) 
This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2022-10-24 09:07:05 +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-19.1.0 chore: release main (#9143) 2022-10-21 15:52:43 +02:00
versioned_sidebars chore: release main (#9143) 2022-10-21 15:52:43 +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 fix: update documentation on configuring puppeteer (#9150) 2022-10-24 09:07:05 +02:00
package.json fix: update documentation on configuring puppeteer (#9150) 2022-10-24 09:07:05 +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 (#9143) 2022-10-21 15:52:43 +02:00
versionsArchived.json chore: release main (#9143) 2022-10-21 15:52:43 +02:00

README.md

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.