History

Jens Langhammer 43c391aa1c docs: move dev setup to docs site, fix docs header		2020-11-30 13:12:56 +01:00
..
docs	docs: move dev setup to docs site, fix docs header	2020-11-30 13:12:56 +01:00
src	docs: move dev setup to docs site, fix docs header	2020-11-30 13:12:56 +01:00
static	docs: update screenshots	2020-11-24 11:51:46 +01:00
.gitignore	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
.prettierignore	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
.prettierrc.json	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
README.md	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
babel.config.js	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
docusaurus.config.js	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
package-lock.json	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
package.json	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
sidebars.js	docs: move dev setup to docs site, fix docs header	2020-11-30 13:12:56 +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.