This repo contains public documentation for Silverpond's Highlighter product.
See /content folder for details.
This documentation site uses Zola to generate a static website. Follow their installation page to install Zola and get started. For ease of use, there's a justfile for common Zola actions.
Or you can use flakes (eg., nix develop or direnv (.envrc) to install Zola and setup the environment.
The static website is deployed via Netlify, follwing Zola's instructions:
- The site is deployed to https://highlighter-docs.netlify.app/ when MRs are merged to
mainin Github. - Deploys are password protected using Basic Password Protection by Netlify. Password is in 1Password "Highlighter" vault.
- There is separate prod site, we will remove the password when it is ready for public view
- Each MR will will create a Deploy Preview URL for review
- Deploys are added as comments to a Github MR
- Deploy notifications are sent via slack to #highlighter-docs
Clone the repo including submodules.
The repo also includes a justfile for common interactions with the repo.
Update content in /content and create an MR.