hugo-paper VS docsy

cd my-blog git init git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper

Download Paper theme for Hugo

A super clean and responsive Hugo theme based on Paper, PaperMod is incredibly popular, and with good reason! It’s optimized for UX, meaning easy reading regardless of light/dark mode preference — ideal for getting your message across to the widest possible audience.

Check theme and use~ 🪴 github.com/nanxiaobei/hugo-paper

> 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.