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

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.