Michael Bromley de8e3c054c docs: Improve docs working with DB relations 2 years ago
..
content 63e7e443bd Merge branch 'minor' into new-docs 2 years ago
docs de8e3c054c docs: Improve docs working with DB relations 2 years ago
layouts 63e7e443bd Merge branch 'minor' into new-docs 2 years ago
scraper 2645afb855 docs: Add complete plugin tutorial 2 years ago
src 24637694f4 docs: Remove beta notice from docs landing page 2 years 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 517bd109cb chore: Get docs building in docusaurus 2 years ago
babel.config.js 517bd109cb chore: Get docs building in docusaurus 2 years ago
docusaurus.config.js 0f3a28e613 docs: Improve docs landing page 2 years ago
package.json 20978e9b5e docs: Get docs build working 2 years ago
sidebars.js 9cb3c6387a docs: Add docs on CLI 2 years ago
tsconfig.json 517bd109cb chore: Get docs building in docusaurus 2 years ago
yarn.lock 20978e9b5e docs: Get docs build working 2 years ago

README.md

Website

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

Installation

$ yarn

Local Development

$ yarn 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

$ yarn 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 yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn 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.