just-the-docs
Wiki.js
just-the-docs | Wiki.js | |
---|---|---|
17 | 122 | |
7,029 | 23,523 | |
1.6% | 1.2% | |
8.4 | 7.1 | |
10 days ago | 7 days ago | |
SCSS | Vue | |
MIT License | 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.
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.
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?
Read the Docs - The source code that powers readthedocs.org
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
jekyll-theme-chirpy - A minimal, responsive, and feature-rich Jekyll theme for technical writing.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
Docusaurus - Easy to maintain open source documentation websites.
Gollum - A simple, Git-powered wiki with a local frontend and support for many kinds of markup and content.
jekyll-docker - ⛴ Docker images, and CI builders for Jekyll.
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.
jekyll-theme-hamilton - A minimal and beautiful Jekyll theme best for writing and note-taking.
XWiki - The XWiki platform