docsy
just-the-docs
docsy | just-the-docs | |
---|---|---|
7 | 17 | |
2,462 | 7,029 | |
1.3% | 1.6% | |
9.2 | 8.4 | |
3 days ago | 7 days ago | |
HTML | SCSS | |
Apache License 2.0 | MIT License |
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.
just-the-docs
-
Gojekyll – 20x faster Go port of jekyll
I think GitHub Pages only supports a whitelist of plugins, so you might have some more difficulties solving it well without any plugins. I use Netlify for my site, which does support arbitrary plugins.
One quick way to make it faster is to include that "_includes/nav.html" only in a nav.html, and then use an iframe to load that on every page, or something like that.
Anyway, I'm not the first to notice this it seems, although even "twice as fast" would still be quite slow: https://github.com/just-the-docs/just-the-docs/issues/1323
-
Having the rules and mechanics easily accessible in a webpage/site.
If it can help, there was a commenter earlier who suggested trying out a Doc-style github page that you can easily fork. It also has its own built-in search. Comment here. Github page here.
-
Looking for advice: does any one use GitHub/GitClassroom to store and mange their course content?
So the basic idea is I use the Jekyll site generator (which is already built into GitHub pages, but you can also install locally), and this is the theme I use: https://just-the-docs.github.io/just-the-docs/
- Is legit to use Github pages for non-coding purposes?
- Keep your diagrams updated with continuous delivery
-
Open Source Like
That's certainly an option. Games like Liminal Horror and Into the Dungeon Revived host versions on GitHub. You can then render it to a GitHub.io page using something like Just the Docs.
-
Compiling findings to website
The pages are written in markdown and the site has an in-built search feature. I am using the https://github.com/just-the-docs/just-the-docs jekyll theme.
-
Atlassian Patch Critical Confluence Hardcoded Credentials Bug
The only people that like confluence have Stockholm syndrome. I'd argue that a wiki is the old people way of thinking. In most orgs a wiki is where data goes to die but some asshole keeps throwing data in there to appease some other asshole. I rather search slack, https://github.com/just-the-docs/just-the-docs, project boards in github, anything is better than confluence and I couldn't agree more that confluence search is the biggest piece of shit ever, it's worse than useless, it wastes your time.
-
Ask HN: What do people use for documentation sites these days?
https://pmarsceill.github.io/just-the-docs/
Especially if you're already familiar with Jekyll. Bonus points for being able to deploy on GitHub Pages!
-
Tags-based documentation build (contextual documentation)
You can use 'Just the Docs' (https://github.com/pmarsceill/just-the-docs) for documentation - it's a Jekyll-based theme for documentation and has built-in search.
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
Read the Docs - The source code that powers readthedocs.org
MkDocs - Project documentation with Markdown.
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
jekyll-theme-chirpy - A minimal, responsive, and feature-rich Jekyll theme for technical writing.
hugo-geekdoc - Hugo theme made for documentation
hugo-blox-builder - 😍 EASILY BUILD THE WEBSITE YOU WANT - NO CODE, JUST MARKDOWN BLOCKS! 使用块轻松创建任何类型的网站 - 无需代码。 一个应用程序,没有依赖项,没有 JS
jekyll-docker - ⛴ Docker images, and CI builders for Jekyll.
doks - Everything you need to build a stellar documentation website. Fast, accessible, and easy to use.
jekyll-theme-hamilton - A minimal and beautiful Jekyll theme best for writing and note-taking.