tree: 08ed5579bb19c0d6b81c6fc947e41a8e9490747a [path history] [tgz]
  1. docs/
  2. src/
  3. static/
  4. .gitignore
  5. docusaurus.config.js
  6. jsdoc.conf.json
  7. package-lock.json
  8. package.json
  9. README.md
  10. sidebars.js
docs/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 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.