Michael Bromley 1f74b2cb52 docs: Add docs on data model & job queue 2 年 前
..
docs 1f74b2cb52 docs: Add docs on data model & job queue 2 年 前
scraper 2645afb855 docs: Add complete plugin tutorial 2 年 前
src a92d95bb05 docs: Add docs on custom fields & strategies etc 2 年 前
static db6d6339d2 docs: Move old olds to temp dir 2 年 前
.gitignore 2645afb855 docs: Add complete plugin tutorial 2 年 前
README.md 517bd109cb chore: Get docs building in docusaurus 2 年 前
babel.config.js 517bd109cb chore: Get docs building in docusaurus 2 年 前
docusaurus.config.js a92d95bb05 docs: Add docs on custom fields & strategies etc 2 年 前
package.json 20978e9b5e docs: Get docs build working 2 年 前
sidebars.js a92d95bb05 docs: Add docs on custom fields & strategies etc 2 年 前
tsconfig.json 517bd109cb chore: Get docs building in docusaurus 2 年 前
yarn.lock 20978e9b5e docs: Get docs build working 2 年 前

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.