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