https://github.com/guacsec/guac-docs
Docs to ingest in GUAC
https://github.com/guacsec/guac-docs
hacktoberfest supply-chain-security
Last synced: 5 months ago
JSON representation
Docs to ingest in GUAC
- Host: GitHub
- URL: https://github.com/guacsec/guac-docs
- Owner: guacsec
- License: cc-by-4.0
- Created: 2023-04-10T06:55:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-06-10T15:19:36.000Z (about 1 year ago)
- Last Synced: 2025-06-15T03:15:33.999Z (about 1 year ago)
- Topics: hacktoberfest, supply-chain-security
- Language: SCSS
- Homepage: https://guac.sh/
- Size: 7.43 MB
- Stars: 8
- Watchers: 8
- Forks: 31
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GUAC Documentation
Documentation is published to [docs.guac.sh](https://docs.guac.sh/). Content is
written in Markdown and rendered with [Jekyll](https://jekyllrb.com/) and the
[Just the Docs theme](https://github.com/just-the-docs/just-the-docs).
## Building
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](https://prettier.io/) on the Markdown
files to check formatting. Before committing changes, you should verify your
formatting with `npx --yes prettier --write --prose-wrap always ./**/*.md`
## Contributing
Text and visual content is under the
[Creative Commons Attribution (CC BY) 4.0 International license](https://creativecommons.org/licenses/by/4.0/).
Code is under the [MIT license](https://opensource.org/license/mit), except
where otherwise noted. Contributions are welcome under the corresponding
license.
This project follows the
[OpenSSF Code of Conduct](https://openssf.org/community/code-of-conduct). See
the [website](https://guac.sh/community) for more information about the GUAC
community.