This repo contains documentation for the Community Health Toolkit (CHT), and how to build digital health applications with CHT Core. This repository powers the CHT documentation site at docs.communityhealthtoolkit.org.
The documentation is built using Markdown pages, which can be converted into a navigable website using a static-site-generator. The Hugo static-site-generator is being used with the Docsy theme. To maintain portability, content should be written in plain Markdown with limited use of HTML, custom shortcodes, and modifications to the theme. Contributions should align with the documentation style guide.
The documentation site uses Hugo, and specifically uses features found in the extended version of Hugo, v0.76.0 and later.
To install, follow the installation instructions for your Operating System, and be sure to get the extended version.
- Build your site:
hugo server- If there are any errors, check that you have the latest version of Hugo, and are using the extended version.
- Preview your site in your browser at: http://localhost:1313/
- As you make changes to the site, your browser will automatically reload your local dev site so you can easily and quickly see your changes.
MacOS users getting fatal error: pipe failed, please see our Troubleshooting guide.
We validate that all links on the docs site work (do not 404) using a tool called Muffet along with Actions. If you're creating a lot of new links, or editing a lot of existing links, you may optionally run Muffet locally before pushing your commits. Running Muffet locally can save time by exposing broken links before pushing a build since you can avoid waiting for the Action to run, finding you have a broken link, fixing it, and pushing a new change.
- Install Go as a prerequisite
- Install Muffet:
go get -u github.com/raviqqe/muffet - Ensure you've run
hugo serverso your local docs instance is reachable at http://localhost:1313/ - Test the links with the
muffet.shscript. If you're in the root of this repo, that'd be:./.github/scripts/muffet.sh
It should take about 60 seconds depending on your Internet connection. If Muffet returns no output, you have no broken links, congrats!
Note: The muffet.sh script here is the identical script we run on GitHub. If you simply run muffet http://localhost:1313 you will hit GitHub's rate limiting and get lots of 429's. Our script intentionally reduces concurrency and excludes some repetitive GitHub URLs.
All changes to main branch run a GitHub action to first check for any broken links (per above) and then deploy to the documentation site: docs.communityhealthtoolkit.org
The version of Hugo used to deploy the site is specified in the GitHub workflows config. To upgrade to a new version of Hugo, simply update the hugo-version property in the workflows to the desired version (after confirming the site functions properly on the new version of Hugo).
(Note there is also a minimum version of Hugo required to deploy the site specified via module.hugoVersion in the config.toml file.)
See the Hugo Release Notes for documentation regarding what has changed in the new versions.
The current version of Docsy is pinned in the go.mod file. To upgrade to a new version of Docsy, use the hugo mod get command as described in the Docsy documentation.
See the Docsy CHANGELOG for documentation regarding what has changed in the new versions.