bo0tzz a1a7e6ac06 Small docs site tweaks (#954) il y a 2 ans
..
blog 8e78160bb9 Change documentation folder to docs il y a 2 ans
docs a1a7e6ac06 Small docs site tweaks (#954) il y a 2 ans
src a1a7e6ac06 Small docs site tweaks (#954) il y a 2 ans
static 9057e4b7d0 Update documentation il y a 2 ans
.gitignore a1a7e6ac06 Small docs site tweaks (#954) il y a 2 ans
README.md 8e78160bb9 Change documentation folder to docs il y a 2 ans
babel.config.js 8e78160bb9 Change documentation folder to docs il y a 2 ans
docusaurus.config.js a1a7e6ac06 Small docs site tweaks (#954) il y a 2 ans
package-lock.json bbe820d797 Switched hero image to webp il y a 2 ans
package.json 8e78160bb9 Change documentation folder to docs il y a 2 ans
sidebars.js 8e78160bb9 Change documentation folder to docs il y a 2 ans
tsconfig.json 8e78160bb9 Change documentation folder to docs il y a 2 ans

README.md

Website

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

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens 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

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.