History

alexstanbury ef40b1db23 docs: Fix Frame Processor install step and QualityPrioritization Order (#451 ) * fix: switched incorrect property ordering for qualityPrioritization options fix: added extra step required for create frame processing plugin on Android * fix: adjusted the highlighted line * chore: added guidelines on how to generate and check docs updares * chore: change instructions so they aren't so unnecessarily wordy! :P		2021-09-24 10:15:26 +02:00
..
docs/guides	docs: Fix Frame Processor install step and QualityPrioritization Order (#451 )	2021-09-24 10:15:26 +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: Upgrade a whole lotta dependencies (#436 )	2021-09-22 13:58:59 +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: Upgrade a whole lotta dependencies (#436 )	2021-09-22 13:58:59 +02: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.