This website is built using Docusaurus 2, a modern static website generator.
When adding a new doc, make sure to add it to /site/sidebars.js
To test, run make docs
to spin up local webserver and view changes with hot reload
Install yarn
(e.g. for Ubuntu, try this guide).
In this directory (retina/site/), run:
yarn
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.
yarn build
This command generates static content into the build
directory and can be served using any static contents hosting service.
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.