planter
Wiki.js
planter | Wiki.js | |
---|---|---|
4 | 122 | |
533 | 23,557 | |
- | 1.2% | |
4.3 | 7.1 | |
about 1 month ago | 5 days ago | |
Go | 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.
planter
-
Documentation as Code for Cloud Using PlantUML
Here's three interesting Rust projects that use plantuml
You can embed plantuml and drawio diagrams in Rust doc comments and have it rendered in the docs, using this crate
https://crates.io/crates/rsdoc
And you can generate plantuml from SQL tables using
https://crates.io/crates/sqlant (this one is a rust port of a go tool, https://github.com/achiku/planter)
And you can embed plantuml in mdbook
https://crates.io/crates/mdbook-plantuml
-
TIL: about Entity Relationship Schemas
You also have PlantUML. There exists an SQL generator for MySQL - not tested - and this utility for generating PlantUML ERD from PostgreSQL tables. This tool is more focussed on communication and allows you to draw large diagrams. However, you loose the sync between the diagram and the code base. You have the official PlantUML on-line drawer.
- Planter: Auto-generate Plant UML diagrams from Postgres tables
-
Plant UML – open-source UML Tool
I use Plant UML in combination with planter [1] to auto-generate a DB schema during CI runs.
Recently I see a lot general statements on HN like "UML is dead" which I think is not the case. Especially in complex, data-heavy projects it's a great way to visualize how things work -- if kept up-to-date and precise.
[1] https://github.com/achiku/planter
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?
plantuml - Generate diagrams from textual description
Outline - The fastest knowledge base for growing teams. Beautiful, realtime collaborative, feature packed, and markdown compatible.
pgadmin4 - pgAdmin is the most popular and feature rich Open Source administration and development platform for PostgreSQL, the most advanced Open Source database in the world.
Dokuwiki - The DokuWiki Open Source Wiki Engine
mdbook-plantuml - mdBook preprocessor to render PlantUML diagrams to png images in the book output directory
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
echosvg - SVG implementation in the Java™ Language, fork of Apache Batik, supporting level 4 selectors and colors.
Gollum - A simple, Git-powered wiki with a local frontend and support for many kinds of markup and content.
aws-icons-for-plantuml - PlantUML sprites, macros, and other includes for Amazon Web Services services and resources
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.
ecto_erd - A mix task for generating Entity Relationship Diagram from Ecto schemas available in your project.
XWiki - The XWiki platform