docsy
Wiki.js
Our great sponsors
docsy | Wiki.js | |
---|---|---|
7 | 122 | |
2,453 | 23,451 | |
2.0% | 1.7% | |
9.2 | 7.1 | |
10 days ago | 19 days ago | |
HTML | Vue | |
Apache License 2.0 | GNU Affero General Public License v3.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.
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.
Wiki.js
-
Adding a simple light box in wiki.js
Wiki.js is a self hosted, open source Wiki that has a lot of awesome functionality. Unfortunately it's lacking some small, but important UI features, like a light box, to enlarge downsized images to it's full size. And unless you want to add a link to each image, to open it in a new tab, you would probably go for a modal view here.
- Ask HN: What are some good documentation OSS offerings
- Wiki.js
-
How do you host documentation for your spouse or other users?
Can't think of anything that meets all the criteria, there's always some compromise, which might just be the way it is. For example I could 'self-host' otterwiki or wiki.js on a VPS for a pretty small monthly fee, which I could also use for other stuff that doesn't make sense for a home lab, but then I also need to deal with security since it's hosted on the internet. Or I could self-host and just accept that there's risk of it not being available when my wife needs it or if I die suddenly.
-
List of your reverse proxied services
WikiJS as Homepage (a bit unusual, I know...)
-
Documentation as Code for Cloud Using PlantUML
I love PlantUML. I was always fond of it in my early days as a software engineer and still use it today, along with all the various ways to draw diagrams out there, whether it's through a web tool like draw.io or Miro or through markup like PlantUML and Mermaid.
Some stuff I'd like to share with the rest:
- PlantUML's default style has improved since the days of red/brown borders, pale yellow boxes, drop shadows and such but I've attempted fixing it before through a preset style [I've made before here](https://gist.github.com/jerieljan/4c82515ff5f2b2e4dd5122d354...). It's obsolete nowadays, since I'm sure someone has made a style generator somewhere, and last I checked, PlantUML allows a monochrome style out of the box.
- [Eraser](https://app.eraser.io) is promising, considering that it's trying to blend both diagram-as-code markup along with the usual visual diagram editor. I'm still seeing if it's worth picking up since Miro's hard to beat.
- On an unrelated note, [WikiJS](https://js.wiki/) is a self-hosted wiki that happens to support draw.io, PlantUML and MermaidJS diagrams out of the box. Quite handy to have for your own docs.
- I use Miro nowadays since it's significantly quicker to draw things freeform and to collaborate live with folks on a whiteboard at the cost of having your diagrams in markup, but it's easy to miss the integration that [you can actually import PlantUML](https://help.miro.com/hc/en-us/articles/7004940386578) and Mermaid diagrams in a Miro board too. You can also do edits too, but it's on its own PlantUML section, of course.
-
wiki.js on YugabyteDB
I've asked on LinkedIn which PostgreSQL application you use so that I can check that it works on Yugabyte. Please, continue to answer. To start let's try with Wiki.js, open source wiki software storing into a PostgreSQL database.
- Tiddlywiki for note taking
-
Anyone know of a free dev docs like confluence?
I like https://js.wiki/
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
Outline - The fastest knowledge base for growing teams. Beautiful, realtime collaborative, feature packed, and markdown compatible.
MkDocs - Project documentation with Markdown.
Dokuwiki - The DokuWiki Open Source Wiki Engine
hugo-geekdoc - Hugo theme made for documentation
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
hugo-blox-builder - 😍 EASILY BUILD THE WEBSITE YOU WANT - NO CODE, JUST MARKDOWN BLOCKS! 使用块轻松创建任何类型的网站 - 无需代码。 一个应用程序,没有依赖项,没有 JS
Gollum - A simple, Git-powered wiki with a local frontend and support for many kinds of markup and content.
doks - Everything you need to build a stellar documentation website. Fast, accessible, and easy to use.
Mediawiki - 🌻 The collaborative editing software that runs Wikipedia. Mirror from https://gerrit.wikimedia.org/g/mediawiki/core. See https://mediawiki.org/wiki/Developer_access for contributing.
hugo-coder - A minimalist blog theme for hugo.
XWiki - The XWiki platform