History

Cody Eakins 12260b19af docs: fix small typo (#8195 ) This commit fixes a single typo. - functon -> function		2022-04-06 08:32:31 +00:00
..
blog	chore: add documentation to new website	2021-08-04 09:00:48 +00:00
src	chore: add documentation to new website	2021-08-04 09:00:48 +00:00
static	chore(docs): basic docusaurus setup (#7438 )	2021-07-26 11:52:25 +00:00
versioned_docs	docs: fix small typo (#8195 )	2022-04-06 08:32:31 +00:00
versioned_sidebars	fix: added names in V9.1.1 (#7547 )	2021-09-14 14:03:28 +00:00
.gitignore	chore(docs): basic docusaurus setup (#7438 )	2021-07-26 11:52:25 +00:00
babel.config.js	chore(docs): basic docusaurus setup (#7438 )	2021-07-26 11:52:25 +00:00
docusaurus.config.js	chore(docs): generate site for v10.0.0	2021-08-09 09:57:14 +01:00
package.json	chore: reduce docusaurus versions that we generate (#7657 )	2021-10-08 13:39:49 +00:00
README.md	chore(docs): basic docusaurus setup (#7438 )	2021-07-26 11:52:25 +00:00
sidebars.js	chore(docs): improve doc links and supported versions	2021-08-17 10:07:23 +01:00
versions.json	chore: reduce docusaurus versions that we generate (#7657 )	2021-10-08 13:39:49 +00:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Its dependencies are purposefully kept separate from the main Puppeteer codebase's in order to avoid having all our end users install them when installing Puppeteer. In the future we may move this website into its own repository.

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 build

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

Deployment

Deploys are automatically handled by the deploy-docs.yml workflow.