API docs v0

v0.docs.wgtwo.com/.

Contributing

Check out CONTRIBUTING.md and add your content to docs/

Prerequisites / install

• rtx (https://github.com/jdx/rtx)
• Node.js 16.x (fixed by using rtx)
• python 3.10 (fixed by using rtx)
• vips (for image processing) brew install vips (for any arm/Mac M1+ users)

If you use pyenv and rtx/asdf then this might be enough:

brew install vips
npm install

If not you might also need:

rtx install [email protected]
rtx install node@16
brew install vips
npm install

Run project

1. npm run develop

Building

npm run build

Development workflow

npm run develop will watch for changes and automatically refresh the site content. If you add a new markdown file or Vue component, you might have to restart the process.

Generate svg from mermaid diagrams

Example on how to regenerate mermaid diagrams:

docker run \
  --rm \
  -v $(pwd)/docs.wgtwo.com/src/assets/images:/data -w /data \
  ghcr.io/mermaid-js/mermaid-cli/mermaid-cli \
  -i /data/number-lookup.mermaid.md \
  -o number-lookup.svg