DevToys-app / DevToys

A Swiss Army knife for developers.
https://devtoys.app/
MIT License
25.72k stars 1.37k forks source link

Feature Request: Mermaid Preview #860

Open bradarm opened 1 year ago

bradarm commented 1 year ago

What feature or new tool do you think should be added to DevToys?

Mermaid is a JavaScript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically. Diagramming and documentation costs precious developer time and gets outdated quickly. But not having diagrams or docs ruins productivity and hurts organizational learning. Mermaid addresses this problem by enabling users to create easily modifiable diagrams. It can also be made part of production scripts (and other pieces of code).

However, most tools today don't offer the ability to develop and preview rendered Mermaid live.

Why do you think this is needed?

Mermaid offers a live editor, but this resource isn't ideal for proprietary or air-gapped projects. Adding a Mermaid Preview to DevToys would allow a developer to rapidly create diagrams using locally-installed tooling.

Solution/Idea

Add a Mermaid Preview tool under the Text section, alongside the existing Markdown Preview tool. Alternatively, updating the Markdown Preview tool to be Mermaid-aware would be greatly beneficial.

Comments

No response

Regenhardt commented 10 months ago

Could add this to the markdown preview tool, two birds one stone.