mirror of
https://github.com/TecharoHQ/anubis.git
synced 2026-04-08 09:38:45 +00:00
865ba0983e
PR #1451 added `CONTRIBUTING.md`, but the commit message guidelines there conflict with the ones in `developer/code-quality.md`. Since `CONTRIBUTING.md` is newer, presumably the guidelines there are what's expected from new commits. But after removing that section from `code-quality.md`, there's not much content left, so this commit just deletes the file entirely. Signed-off-by: Max Chernoff <git@maxchernoff.ca>
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.