History

Marc Rousavy f84368050d Remove ignored files		2021-03-03 21:26:04 +01:00
..
docs	Remove ignored files	2021-03-03 21:26:04 +01:00
src	Fix img urls	2021-03-03 12:45:15 +01:00
static	move favicons	2021-03-03 20:50:32 +01:00
.gitignore	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
babel.config.js	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
docusaurus.config.js	Fix docusaurus setup	2021-03-03 21:20:20 +01:00
package.json	Fix docusaurus setup	2021-03-03 21:20:20 +01:00
README.md	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
sidebars.js	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
yarn.lock	Fix docusaurus setup	2021-03-03 21:20:20 +01:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

GIT_USER=<Your GitHub username> USE_SSH=true 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.