mermaid
vscode-drawio
Our great sponsors
- Amplication - open-source Node.js backend code generator
- Appwrite - The open-source backend cloud platform
- SurveyJS - A Non-Cloud Alternative to Google Forms that has it all.
- InfluxDB - Collect and Analyze Billions of Data Points in Real Time
- Sonar - Write Clean JavaScript Code. Always.
- Mergify - Updating dependencies is time-consuming.
mermaid | vscode-drawio | |
---|---|---|
108 | 5 | |
61,204 | 8,798 | |
2.5% | - | |
9.9 | 0.0 | |
6 days ago | 6 months ago | |
JavaScript | TypeScript | |
MIT License | GNU General Public License v3.0 only |
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.
mermaid
-
Top 6 tools for text-based UML sequence diagrams
Mermaid is a Javascript-based diagramming tool for rendering many diagram types from Markdown-inspired text definitions and supports sequence diagrams. Mermaid is free and open-source under the MIT license.
-
The Unreasonable Effectiveness of Sequence Diagrams in MermaidJS
I'm one of the maintainers of the mermaid-cli project, and unfortunately, no.
Mermaid needs a browser's layout engine to run properly [1], but I haven't yet seen a library that will help us without puppeteer.
And yep, NPM (or another Node.JS package manager) is still needed for installation. I was working on trying to bundle all of mermaid-cli's dependencies (aka Node.JS, puppeteer) into one massive single-file exe last weekend, but it's seems we're blocked by missing features in other packages [2].
If anyone has any ideas on how to implement these things easily, feel free to help-out :) I'm also not a big fan of puppeteer, so I'd love to see a way to go without it.
[1]: https://github.com/mermaid-js/mermaid/issues/3650
[2]: https://github.com/mermaid-js/mermaid-cli/issues/467#issueco...
-
How to Write a Great Readme
I like using mermaid diagrams [1] in readme files and docs.
They're easier to read than plain text explanations for architectural layouts/customer journeys but easier to modify than images and GIFs.
Also natively supported in many flavours of markdown like Gitlab.
-
Creating Better API Architecture Diagrams
UML is just one format for diagram design specifications. Another option is to use a code to diagram tool like Mermaid. Mermaid transforms plain-text (Markdown inspired text definitions in this case) into full-fleshed visual diagrams. Their tool is open-source and written in JavaScript, making it easy to customize if you’re so inclined. Advantages include:
-
Which tools do you use to create diagrams?
MermaidJS
-
Diagrams as Code
Another solution which I prefer is - maintaining diagrams as code which live in the same repos as the code. There are many tools these days which help us author diagrams from code. My favorites are Mermaid and PlantUML. Now your code can live in the repo and evolve along with the codebase. You might need to do additional setup if you'd like the diagrams to be generated as part of your CI/CD. I like to maintain these in a /docs folder within the project repo.
-
Mermaid Cheat Sheet
Individual diagrams have their grammar in a .jison file.
Flowchart: https://github.com/mermaid-js/mermaid/blob/develop/packages/...
A single grammar to support all the different use cases would be challenging. But we did have some plans to introduce guidelines to make different diagram syntaxes more consistent.
This would really be a good UX improvement.
But the implementation might be a little tricky.
Please raise an issue so we can discuss further, and add it to roadmap if feasible.
-
A command line tool that draw plots on the terminal
This is so cool. It reminds me of Markdown and Mermaid (https://github.com/mermaid-js/mermaid), which can do a similar thing within a plain text file. Keep it up; looking forward to trying it out.
vscode-drawio
-
Gitlab VSCode Extension Now Supports Locally-Hosted AI Completion with FauxPilot
Open VSX allows anyone to upload an extension there with the same name and description from the VSCode marketplace, but silently change code or make new releases, maybe introducing misfeatures or malicious code. Users typically don't notice because they think they are installing "the same" extension from the VSCode marketplace.
https://github.com/hediet/vscode-drawio/issues/141
> Hi ;)
> I never published a version v999.0! It seems like you are using the unofficial open vsx marketplace (where, apparently, anyone can upload anything). You can find an issue here in this repository about it.
> Unfortunately, someone uploaded the extension in that version which blocks any further updates with that name.
> For now I believe in Microsofts vision. I don't think a secondary marketplace is good for the community - It just causes confusions like this.
> If you setup a github action that automatically publishes this extension to open vsx, please open a PR! ;)
The established practice of having random individuals set up ad-hoc mirrors of VSCode extensions is a serious security issue.
If Open VSX wants to mirror VSCode extensions, that's okay - but they should do so with an automated process that mirrors ALL extensions and do not allow for people to silently change the code of an extension.
If someone want to copy the code of an existing VSCode extension, change some things and upload it to Open VSX, that's okay too, but please fork it and clearly indicate in the description that the extension is a fork, linking to the source code of the original extension.
-
VSCode extensions that you need [Webdevs]🚀🔧
7. Draw.io integration
-
Ask HN: What diagrams do you use in software development?
You can find it here: https://marketplace.visualstudio.com/items?itemName=hediet.v...
Like draw.io, it is open source! (https://github.com/hediet/vscode-drawio)
What are some alternatives?
plantuml - Generate diagrams from textual description
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
aws-icons-for-plantuml - PlantUML sprites, macros, and other includes for Amazon Web Services services and resources
draw.io - draw.io is a JavaScript, client-side editor for general diagramming and whiteboarding
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams
graphviz
Graphviz - Simple Python interface for Graphviz
markdown-preview-enhanced - One of the 'BEST' markdown preview extensions for Atom editor!
gcp-icons-for-plantuml - PlantUML sprites, macros, and other includes for Google Cloud Platform services and resources
GoJS, a JavaScript Library for HTML Diagrams - JavaScript diagramming library for interactive flowcharts, org charts, design tools, planning tools, visual languages.
sphinx-diagrams - Rough Sphinx extension for diagrams