tree: 8c146c2cb3f6854e0113361cbb1579b119061440 [path history] [tgz]
  1. docs/
  2. src/
  3. static/
  4. .gitignore
  5. babel.config.js
  6. docusaurus.config.js
  7. package-lock.json
  8. package.json
  9. README.md
  10. sidebars.js
src/README.md

Website

This website is built using Docusaurus, 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.