diff options
| author | Xe Iaso <me@xeiaso.net> | 2025-03-20 15:06:58 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-03-20 15:06:58 -0400 |
| commit | c47347ff76f115f56676f5ecad0032bfcb98a03d (patch) | |
| tree | 53b17e30a83dab1f96acf64ba83655340d8e1a5f /docs/README.md | |
| parent | 240159e921449236c79e3ae8c7160dfe8ee1b40c (diff) | |
| download | anubis-c47347ff76f115f56676f5ecad0032bfcb98a03d.tar.xz anubis-c47347ff76f115f56676f5ecad0032bfcb98a03d.zip | |
add docs site based on docusarus (#35)
* add docs site based on docusarus
Closes #2
Signed-off-by: Xe Iaso <me@xeiaso.net>
* docs: deploy to aeacus
Signed-off-by: Xe Iaso <me@xeiaso.net>
* ready for merge
Signed-off-by: Xe Iaso <me@xeiaso.net>
* docs: fix anubis port
Signed-off-by: Xe Iaso <me@xeiaso.net>
---------
Signed-off-by: Xe Iaso <me@xeiaso.net>
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 41 |
1 files changed, 41 insertions, 0 deletions
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=<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. |