From c47347ff76f115f56676f5ecad0032bfcb98a03d Mon Sep 17 00:00:00 2001 From: Xe Iaso Date: Thu, 20 Mar 2025 15:06:58 -0400 Subject: add docs site based on docusarus (#35) * add docs site based on docusarus Closes #2 Signed-off-by: Xe Iaso * docs: deploy to aeacus Signed-off-by: Xe Iaso * ready for merge Signed-off-by: Xe Iaso * docs: fix anubis port Signed-off-by: Xe Iaso --------- Signed-off-by: Xe Iaso --- docs/README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs/README.md (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..0c6c2c2 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,41 @@ +# Website + +This website is built using [Docusaurus](https://docusaurus.io/), 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= 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. -- cgit v1.2.3