History

dependabot[bot] eff2e17c97 chore(deps-dev): bump typedoc from 0.22.4 to 0.22.5 in /docs (#475 ) Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.22.4 to 0.22.5. - [Release notes](https://github.com/TypeStrong/TypeDoc/releases) - [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md) - [Commits](https://github.com/TypeStrong/TypeDoc/compare/v0.22.4...v0.22.5) --- updated-dependencies: - dependency-name: typedoc dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>		2021-10-05 10:38:37 +02:00
..
docs/guides	docs: Fix small typo (#473 )	2021-10-02 15:07:32 +02:00
src	Move Guides to docs/guides directory (#96 )	2021-03-23 15:25:27 +01:00
static	docs: Add Frame Processor benchmarks (#154 )	2021-05-30 12:13:50 +02: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	chore: Upgrade a whole lotta dependencies (#436 )	2021-09-22 13:58:59 +02:00
package.json	chore(deps-dev): bump typedoc from 0.22.4 to 0.22.5 in /docs (#475 )	2021-10-05 10:38:37 +02:00
README.md	Automatically build API documentation (#11 )	2021-03-03 12:37:43 +01:00
sidebars.js	chore: Upgrade a whole lotta dependencies (#436 )	2021-09-22 13:58:59 +02:00
yarn.lock	chore(deps-dev): bump typedoc from 0.22.4 to 0.22.5 in /docs (#475 )	2021-10-05 10:38:37 +02: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.