Documentation is published to docs.guac.sh. Content is written in Markdown and rendered with Jekyll and the Just the Docs theme.
Install requirements with bundler install
in the top-level directory.
To build locally, run bundler exec jekyll serve
. By default, the output will
be available on http://127.0.0.1:4000/guac-docs
The deployment pipeline runs Prettier on the Markdown
files to check formatting. Before committing changes, you should verify your
formatting with npx --yes prettier --write --prose-wrap always *.md
Contributions are welcome.
This project follows the OpenSSF Code of Conduct. See the website for more information about the GUAC community.