.. | |||
docs | Loading last commit info... | ||
public | |||
scripts | |||
src | |||
static | |||
wiki | |||
.gitignore | |||
CONTRIBUTING.md | |||
README.md | |||
babel.config.js | |||
docusaurus.config.js | |||
package.json | |||
sidebars.js | |||
sidebarsWiki.js | |||
tsconfig.json | |||
yarn.lock |
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
$ 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.