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.
This documentation site follows the Diátaxis method of documentation:
- Concepts (for explanation and learning)
- Getting Started and Tutorials sections (to be developed)
- How-To Guide section (to be developed)
- Reference (to be developed)
The static website is deployed via Netlify, following Zola's instructions:
- The site is deployed to https://highlighter-docs.netlify.app/ when MRs are merged to
mainin Github. - 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.
Enter a dev shell via nix develop
Serve the site locally in development mode via zola serve
Update content in /content and create an MR.