planter
mdbook-plantuml
| planter | mdbook-plantuml | |
|---|---|---|
| 4 | 1 | |
| 532 | 75 | |
| - | - | |
| 4.3 | 0.0 | |
| about 1 month ago | about 1 year ago | |
| Go | Rust | |
| MIT License | 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.
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
mdbook-plantuml
-
Documentation as Code for Cloud Using PlantUML
I started using plantuml more rigorously at work. I've found that collaboration on the drawings/diagrams, is simpler and easier as it can be tracked in Git. One additional thing that I've been using as well is the mdBook plugin to embed and render the images as part of a larger book. This has been helpful for large systems when there are many teams involved.
https://github.com/sytsereitsma/mdbook-plantuml
What are some alternatives?
plantuml - Generate diagrams from textual description
gooseberry - A command line utility to generate a knowledge base from Hypothesis annotations
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.
mdbook-pdf - A backend for mdBook written in Rust for generating PDF based on headless chrome and Chrome DevTools Protocol. (用 Rust 编写的 mdBook 后端，基于headless chrome和Chrome开发工具协议生成PDF)
echosvg - SVG implementation in the Java™ Language, fork of Apache Batik, supporting level 4 selectors and colors.
mdbook-i18n-helpers - Translation support for mdbook. The plugins here give you a structured way to maintain a translated book.
aws-icons-for-plantuml - PlantUML sprites, macros, and other includes for Amazon Web Services services and resources
ecto_erd - A mix task for generating Entity Relationship Diagram from Ecto schemas available in your project.
roam - Roam notes
mdbook-admonish - A preprocessor for mdbook to add Material Design admonishments.