argos/docs
Alexandros Mandilaras d62b988857 dockerfile update 2024-10-01 16:37:26 +03:00
..
docs/documentation docs update 2024-10-01 14:36:03 +03:00
src More fixes on plans and descriptions docs 2024-05-16 17:03:20 +03:00
static added docs project 2024-04-18 13:08:56 +03:00
.gitignore added docs project 2024-04-18 13:08:56 +03:00
Dockerfile dockerfile update 2024-10-01 16:37:26 +03:00
README.md added docs project 2024-04-18 13:08:56 +03:00
babel.config.js added docs project 2024-04-18 13:08:56 +03:00
docusaurus.config.ts Docusaurus cleanup, adding docs for entity locks and tenant users, updating authz docs. 2024-07-02 15:52:25 +03:00
nginx.conf.CI dockerfile update 2024-10-01 16:37:26 +03:00
package-lock.json Docusaurus version update to 3.4.0, added doc page for annotation statuses administration 2024-07-10 16:31:57 +03:00
package.json Docusaurus version update to 3.4.0, added doc page for annotation statuses administration 2024-07-10 16:31:57 +03:00
sidebars.ts Docusaurus cleanup, adding docs for entity locks and tenant users, updating authz docs. 2024-07-02 15:52:25 +03:00
start_nginx.sh dockerfile update 2024-10-01 16:37:26 +03:00
tsconfig.json added docs project 2024-04-18 13:08:56 +03:00

README.md

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.