mdBook
Wiki.js
Our great sponsors
mdBook | Wiki.js | |
---|---|---|
100 | 122 | |
16,426 | 23,250 | |
3.0% | 1.8% | |
8.7 | 7.1 | |
7 days ago | 6 days ago | |
Rust | Vue | |
Mozilla Public 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.
mdBook
- Doks – Build a Docs Site
-
Ask HN: How do you organize software documentation at work?
I'm responsible for a number of Java products. I try to provide high-quality Javadoc for all public library interfaces, library user's guides where appropriate, and development guides for applications. The latter two take the form of MDBook documents (https://rust-lang.github.io/mdBook/), with the document source living in the GitHub repo so that it's tied to the particular software release in a natural way.
-
Outline: Self hostable, realtime, Markdown compatible knowledge base
My org has used mdBook: https://rust-lang.github.io/mdBook/ (That link is itself a rendered mdBook, so that'll give you an idea of the feature set.)
(While it's definitely a Rust "thing", if you just have a set of .md files, all you need is a "SUMMARY.md" (which contains the ToC) and a small config file; i.e., you don't have to have any Rust code to use it, and it works fine without. We document a large, mostly non-Rust codebase with it.)
-
Ask HN: Best tools for self-authoring books in 2023?
If you want the lowest friction, open source, easily extensible Markdown to Web, Kindle, PDF, etc. tool, highly recommend mdBook: https://github.com/rust-lang/mdBook it’s written in Rust, but you don’t have to know any Rust to use it. And then wing is all CSS; for which there are many good (free) themes.
- FLaNK Stack for 4th of July
-
MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
Interesting enough there seems to be an open PR for that: https://github.com/rust-lang/mdBook/pull/1918
- Effective Rust
-
is it possible to read books in vim?
If you are interested to draw something I also suggest you to use mdbook
- Super unpopular opinion incoming.
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.
- Tiddlywiki for note taking
-
Anyone know of a free dev docs like confluence?
I like https://js.wiki/
- Selbstgehostetes Wiki mit "Querverweisen"?
-
ISO: Information aggregate, doc store, notes. In Docker.
https://js.wiki/ or any wiki really
-
Looking for a CMS thats like linear.app
I use wikijs and is perfect for home wiki with modern look and good features https://js.wiki/
- Gibt es kein Selbst Hostbares Wiki ähnlich Confluence?
-
How can I publish my vault to a website with community plugins?
I think it could be a little bit difficult, but you can try using other tools like wiki js
What are some alternatives?
Outline - The fastest knowledge base for growing teams. Beautiful, realtime collaborative, feature packed, and markdown compatible.
Dokuwiki - The DokuWiki Open Source Wiki Engine
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
Gollum - A simple, Git-powered wiki with a sweet API and local frontend.
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.
XWiki - The XWiki platform
Trilium Notes - Build your personal knowledge base with Trilium Notes
gitbook - 📝 Modern documentation format and toolchain using Git and Markdown
MkDocs - Project documentation with Markdown.
Documize - Modern Confluence alternative designed for internal & external docs, built with Go + EmberJS
TiddlyWiki - A self-contained JavaScript wiki for the browser, Node.js, AWS Lambda etc.