Michael Bromley 50e5df0b28 docs(core): Improve accuracy of stock control docs hai 1 ano
..
content 63e7e443bd Merge branch 'minor' into new-docs %!s(int64=2) %!d(string=hai) anos
docs 50e5df0b28 docs(core): Improve accuracy of stock control docs hai 1 ano
layouts 63e7e443bd Merge branch 'minor' into new-docs %!s(int64=2) %!d(string=hai) anos
scraper 3322a5633e docs: Fix scraper config %!s(int64=2) %!d(string=hai) anos
src 671c271731 docs: Update Northflank deployment guide %!s(int64=2) %!d(string=hai) anos
static eb548906dd docs: Add redirects for old docs urls %!s(int64=2) %!d(string=hai) anos
.gitignore 2645afb855 docs: Add complete plugin tutorial %!s(int64=2) %!d(string=hai) anos
README.md 517bd109cb chore: Get docs building in docusaurus %!s(int64=2) %!d(string=hai) anos
babel.config.js 517bd109cb chore: Get docs building in docusaurus %!s(int64=2) %!d(string=hai) anos
docusaurus.config.js f1a8f134a3 docs: Fix edit docs link %!s(int64=2) %!d(string=hai) anos
package.json 20978e9b5e docs: Get docs build working %!s(int64=2) %!d(string=hai) anos
sidebars.js 901b055b00 Merge branch 'master' into minor %!s(int64=2) %!d(string=hai) anos
tsconfig.json 517bd109cb chore: Get docs building in docusaurus %!s(int64=2) %!d(string=hai) anos
yarn.lock 20978e9b5e docs: Get docs build working %!s(int64=2) %!d(string=hai) anos

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.