Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 1.74 KB

README.md

File metadata and controls

62 lines (38 loc) · 1.74 KB

This website is built using Docusaurus 2, a modern static website generator.

Structure

This repo has two main folders: 'versioned_docs/version-latest' and 'docs'. 'versioned_docs/version-latest' holds the latest official release of our documentation, while 'docs' has pre-release versions for testing. Switch between them using the toggle in the top right corner.

folders toggle

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.

Contributing

If you would like to contribute check out the following materials, and feel free to ask questions in our Discord

Thank you to all our Contributors!