SUAVE Docs

This website is built using Docusaurus 3, a modern static website generator.

Getting started

Use Node.js v18+

# check out git submodules
git submodule init
git submodule update

Note: if you want to install the node packages from within a Docker container (recommended for security), then you can start it like this:

docker run -p 3000:3000 --name suave-docs --rm -it -w /mnt -v $(pwd):/mnt node:20 /bin/bash

# shortcut:
make docker

First create a copy of the environment file .env.template in the root of the codebase and rename it to .env:

cp .env.template .env

Then install the dependencies and serve the content:

# install dependencies
npm install

# start dev-server
npm start

# doing the same in Docker:
make docker-deps
make docker-start

Changes are reflected live without having to restart the server.

You can open the local docs at http://localhost:3000/docs

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Use this command to update to the latest version of suave-specs:

git submodule update --remote

The SUAVE standard library is automatically updated by this CI workflow and used with https://docusaurus.io/docs/sidebar/autogenerated

The docs use Vercel for hosting, and deployment is done by Vercel on any merge into the main branch.

If you want to use icons, best copy the SVG from one of these: