Example of what docs would look like on public website built on github pages
Using github-pages, the actinos pipeline for this repository, uses a static-site generator called hugo to create a html/css content from the markdown files in /content/
. Default Hugo creates plan html websites with little design, so to get a more robust site, we're using the docsy theme. This theme includes templates for documentation, search, and best practices as seen in its docs page linked in the previous sentence.
This is all configured under jobs in the github workflow for this repository.
Esentially, this builds from the workflow after any push to main using the gohugo.io hugo binary
since we'll want to test things locally before uploading to main, you can:
- download hugo locally: (windows: https://gohugo.io/installation/windows/#prebuilt-binaries)
- download git if you don't have it: https://git-scm.com/downloads/win (download 64-bit windows)
- if you don't have go, you'll need it to pull in the website depends: https://go.dev/dl/ (windows download the .msi file under: https://go.dev/dl/#featured)
- clone the docs repo locally:
git clone https://github.com/mreeve-snl/docs-test.git
- run
hugo serve
in the repo directory to build it and see it in the browser locally atlocalhost:1313