I’m a big fan of Go so Hugo is a great tool and I’ve been having a lot of fun with it. I’m not sure I’ve taken much advantage of the Go bit aside from using a great tool in go. Can you extend hugo with go plugins?
Anyways, in the past I’ve used docusaurus which is a great tool to generate docs but after a while it gets tiring getting all the JS security alerts. I’d much rather use hugo.
Questions:
Is anyone using go to deliver a pretty documentation site and have any examples of what you’re doing?
I know lunar.js is one pattern, but how are people handling the hugo searching limitations ?
Hi, a lot of the docs in the cloud-native world are built using Hugo, for example, Istio / Docs , Getting started | Kubernetes , and many others. There are themes and sites that support client-side search using lunr or a similar tool, while others use Algolia as a service (see for example the docsy theme).
Thanks for the info that’s useful though one question. It seems like Hugo only maintains 2 iterations of the documentation. Current version (master) of next version (next branch). Is there any thought on supporting multiple version drop downs like for example: https://docusaurus.io/ Please note the version drop down at the top of the page where you can select which version of the docs you’re interested in.
I’d be curious to know even how we’d go about adding that type of support. It does complicates things but it is very nice for some projects to have historical versions you can navigate to.
Out of curiosity, if you finalized how you’re managing the deltas between versions I will be curious to know what your solution is.
One of the drawbacks of the previous tool I used was that it wasn’t easy to make changes to the documentation after you cut a release. Meaning if there was a spelling mistake in version 1.0 and we’ve already shipped to version 1.1, it was really difficult to do a fix and deploy its and have it be reflected in the previously released version.
That aside, I’m really excited about the prospects of seeing the final version released.
Yes there are a number of ways to do this. Since it’s more of a preferred process, I was thinking of writing a setup guide for a number of possibilities, e.g. proxying branch deploys using Netlify, and duplicating versioned documentation content (single repo setup).
