docuowl
docsy
docuowl | docsy | |
---|---|---|
4 | 7 | |
1,269 | 2,462 | |
0.0% | 1.3% | |
0.0 | 9.2 | |
about 1 year ago | 3 days ago | |
Go | HTML | |
MIT License | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
docuowl
docsy
-
Apply Docsy
> cd (The root directory of the Git project. themes exists in current) > git submodule add https://github.com/google/docsy.git themes/docsy
-
”Docsy” is a formal theme for technical documentation
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
-
Fifty of 2022's most popular Hugo themes
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
-
Twelve Amazing Free Hugo Documentation Themes
Download Docsy Docsy demo site ​​​​Minimum Hugo version: 0.73 GitHub stars: 1.7k License: Apache-2.0
-
Ask HN: What are you using for public documentation these days?
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
-
Need help
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.
What are some alternatives?
doctave - A batteries-included developer documentation site generator
Docusaurus - Easy to maintain open source documentation websites.