Michael Bromley 7b0a26ee50 docs(core): Add docs on caching 1 year ago
..
content 63e7e443bd Merge branch 'minor' into new-docs 2 years ago
docs 7b0a26ee50 docs(core): Add docs on caching 1 year ago
layouts 63e7e443bd Merge branch 'minor' into new-docs 2 years ago
scraper 3322a5633e docs: Fix scraper config 2 years ago
src 7114d20ae2 docs: Fix rendering of default values in reference docs 1 year ago
static eb548906dd docs: Add redirects for old docs urls 2 years ago
.gitignore 2645afb855 docs: Add complete plugin tutorial 2 years ago
README.md e5f0d48913 chore(docs): Update readme docusaurus version 1 year ago
babel.config.js 517bd109cb chore: Get docs building in docusaurus 2 years ago
docusaurus.config.js 2f2248c5cc docs: Restore user guide docs 1 year ago
package-lock.json 623c5b402a chore(docs): Update styles to align with website and Docusauras v2 to v3 upgrade (#2897) 1 year ago
package.json 623c5b402a chore(docs): Update styles to align with website and Docusauras v2 to v3 upgrade (#2897) 1 year ago
sidebars.js 7b0a26ee50 docs(core): Add docs on caching 1 year ago
tsconfig.json 517bd109cb chore: Get docs building in docusaurus 2 years ago

README.md

Website

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

Installation

$ npm run

Local Development

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