Michael Bromley 9a7b35259d chore: Move from Yarn v1.x to npm il y a 1 an
..
content 63e7e443bd Merge branch 'minor' into new-docs il y a 2 ans
docs 34b0f03310 docs: Add docs on overriding Admin UI routes il y a 1 an
layouts 63e7e443bd Merge branch 'minor' into new-docs il y a 2 ans
scraper 3322a5633e docs: Fix scraper config il y a 2 ans
src 671c271731 docs: Update Northflank deployment guide il y a 2 ans
static eb548906dd docs: Add redirects for old docs urls il y a 2 ans
.gitignore 2645afb855 docs: Add complete plugin tutorial il y a 2 ans
README.md 9a7b35259d chore: Move from Yarn v1.x to npm il y a 1 an
babel.config.js 517bd109cb chore: Get docs building in docusaurus il y a 2 ans
docusaurus.config.js f1a8f134a3 docs: Fix edit docs link il y a 2 ans
package.json 386dd4fce4 chore: Update TypeScript to v5.3.3 il y a 1 an
sidebars.js 901b055b00 Merge branch 'master' into minor 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

$ npm run

Local Development

$ npm run 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

$ npm run 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 npm run deploy

Not using SSH:

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