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

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.