History

Marc Rousavy 0fc0dc04ae Add typescript dep		2021-03-03 13:03:29 +01:00
..
blog	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
docs	Update FRAME_PROCESSORS.md	2021-03-03 12:47:17 +01:00
src	Fix img urls	2021-03-03 12:45:15 +01:00
static	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
.gitignore	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
android-chrome-192x192.png	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
android-chrome-512x512.png	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
apple-touch-icon.png	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	Update docusaurus.config.js	2021-03-03 12:49:31 +01:00
favicon-16x16.png	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
favicon-32x32.png	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
favicon.ico	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
package.json	Add typescript dep	2021-03-03 13:03:29 +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
site.webmanifest	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
typedoc-sidebar.js	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
yarn.lock	Add typescript dep	2021-03-03 13:03:29 +01:00

README.md

Website

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

Installation

yarn install

Local Development

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.

Build

yarn build

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

Deployment

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.