beautifulhugo VS docsy

The great thing about Hugo is we can just use a theme as is or we can edit and add to the theme over time. Just make sure the theme you want to edit has a license that allows for it! Most of the themes have a MIT License, which is fine to edit and build on. Editing Hugo themes does require some level of knowledge in html and css. Don't know it? That's fine, just leave the theme as is! That's the great thing about building a site with Hugo. The theme on our website is based on beautifulhugo.

git submodule add https://github.com/halogenica/beautifulhugo.git themes/beautifulhugo

Shortcode provider URL Hugo https://gohugo.io/content-management/shortcodes/#what-a-shortcode-is Theme:Beautiful Hugo https://github.com/halogenica/beautifulhugo#extra-shortcodes Theme:Docsy https://www.docsy.dev/docs/adding-content/shortcodes/

Open Beautiful Hugo's GitHub in your browser and press Code → Download ZIP. The latest theme file will be downloaded in zip format.

Site URL Hugo theme introduction https://themes.gohugo.io/themes/beautifulhugo/ Sample/Demo https://pages.gitlab.io/hugo/ Documentation https://github.com/halogenica/beautifulhugo/blob/master/README.md Repository https://github.com/halogenica/beautifulhugo

Download Beautiful Hugo theme

This is all new to me. I'm trying to figure out how to use Beautiful Hugo theme (https://github.com/halogenica/beautifulhugo) instead of the built-in themes in GitHub.

Fairly recently I changed my theme for my personal blog. I switched to Beautifulhugo. I find it to be a nice clean theme.

> cd (The root directory of the Git project. themes exists in current) > git submodule add https://github.com/google/docsy.git themes/docsy

Site URL Hugo theme introduction https://themes.gohugo.io/themes/docsy/ Sample/Demo https://example.docsy.dev/ Documentation https://www.docsy.dev/ Repository https://github.com/google/docsy

A set of Hugo documentation templates for launching open source content. Use case(s): Documentation Author: The Docsy Authors Minimum Hugo version: 0.73.0 Github stars: 1706 Last updated: 2022-05-14 License: Apache-2.0

Download Docsy Docsy demo site ​​​​Minimum Hugo version: 0.73 GitHub stars: 1.7k License: Apache-2.0

Background: I've been a technical writer for 9 years. 6 at Google, 3 as the only writer at an IoT startup.

I helped Corrily with their docs [1] in August. They were interested in readme.io. I wasn't keen on it because I had worked with Retool a few years back and had found readme.io lacking. But I was pleasantly surprised by how much readme.io has progressed since then! If you're looking for a documentation product that is very easy to update and mostly just works, then it's worth checking out.

On https://web.dev I was introduced to Eleventy. Eleventy [2] is now my go to. The documentation for Elecenty itself is very strangely organized and needs a refactor. But I have found that there is always a way to accomplish whatever I need, and usually elegantly.

Another project worth checking out is Docsy [3]. This is a Jekyll template specifically created for technical documentation.

Back at the IoT startup I had to set up the whole documentation system / tooling myself. I used Sphinx and deployed to Heroku. Haven't used Sphinx since then but I remember being satisfied with it back then.

[1] https://docs.corrily.com

[2] https://11ty.dev

[3] https://docsy.dev

I haven't used either of these, but I've heard good things about both https://github.com/google/docsy and https://thegooddocsproject.dev/. If you choose to use either of these, I'd love to hear about it. I have coworkers who contribute to both of them.