1# Website 2 3This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. 4 5The instructions bellow assume that you're inside `docs/` directory. 6 7### Installation 8 9``` 10$ npm install 11``` 12 13### Local Development 14 15``` 16$ npm start 17``` 18 19This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. 20 21### Build 22 23``` 24$ npm run build 25``` 26 27This command generates static content into the `build` directory and can be served using any static contents hosting service. 28 29### Deployment 30 31The site is built and published to GitHub Pages via GitHub Actions. 32 33### Manual Deployment 34 35Using SSH: 36 37``` 38$ USE_SSH=true yarn deploy 39``` 40 41Not using SSH: 42 43``` 44$ GIT_USER=<Your GitHub username> yarn deploy 45``` 46 47If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. 48