History

Marc Rousavy 2925b846b1 Adjust typedoc API generator settings		2021-03-07 14:16:11 +01:00
..
docs	Update TROUBLESHOOTING.mdx	2021-03-07 14:11:39 +01:00
src	Adjust theme colors	2021-03-04 18:14:07 +01:00
static	Update demo.gif	2021-03-04 17:07:44 +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	Adjust typedoc API generator settings	2021-03-07 14:16:11 +01:00
package.json	Upgrade all packages to latest	2021-03-03 21:56:03 +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	Upgrade all packages to latest	2021-03-03 21:56:03 +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.