32300efccd
The Docusaurus process has been OOMing on the bots; this is a problem we'll want to fix properly when we are shipping the new docs fully, as we want to generate docs for old versions; but for now whilst we're not fully pushing users to this site, we can just generate one version and not worry about multiples. This commit also bumps the version of Docusaurus to the latest beta version. |
||
---|---|---|
.. | ||
blog | ||
src | ||
static | ||
versioned_docs | ||
versioned_sidebars | ||
.gitignore | ||
babel.config.js | ||
docusaurus.config.js | ||
package.json | ||
README.md | ||
sidebars.js | ||
versions.json |
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.