tree: 480f263229651eec8475a2aa7b5ffd4fe8226caa [path history] [tgz]
  1. docs/
  2. src/
  3. static/
  4. .gitignore
  5. .prettierrc
  6. babel.config.js
  7. docusaurus.config.js
  8. package.json
  9. README.md
  10. sidebars.js
  11. tsconfig.json
  12. yarn.lock
docs/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 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

$ 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.