Michael Bromley 2645afb855 docs: Add complete plugin tutorial il y a 2 ans
..
docs 2645afb855 docs: Add complete plugin tutorial il y a 2 ans
scraper 2645afb855 docs: Add complete plugin tutorial il y a 2 ans
src 2645afb855 docs: Add complete plugin tutorial il y a 2 ans
static db6d6339d2 docs: Move old olds to temp dir il y a 2 ans
.gitignore 2645afb855 docs: Add complete plugin tutorial il y a 2 ans
README.md 517bd109cb chore: Get docs building in docusaurus il y a 2 ans
babel.config.js 517bd109cb chore: Get docs building in docusaurus il y a 2 ans
docusaurus.config.js 2645afb855 docs: Add complete plugin tutorial il y a 2 ans
package.json 20978e9b5e docs: Get docs build working il y a 2 ans
sidebars.js 2645afb855 docs: Add complete plugin tutorial il y a 2 ans
tsconfig.json 517bd109cb chore: Get docs building in docusaurus il y a 2 ans
yarn.lock 20978e9b5e docs: Get docs build working il y a 2 ans

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.