Skip to content

Latest commit

 

History

History
20 lines (12 loc) · 1.5 KB

readme.md

File metadata and controls

20 lines (12 loc) · 1.5 KB
Raw

Mermaid Preview

This is an app for Slack that renders Mermaid diagrams in Slack.

This app adds a /mermaid command to your Slack workspace. You can use it to post Mermaid diagrams in Slack messages.

Add to Slack

Mermaid Preview screenshot

How it works

The app listens for a /mermaid command and opens a Slack modal where you can enter your Mermaid diagram code. After you submit the modal, the app renders the diagram using Mermaid CLI into a PNG file. This PNG is uploaded to Slack and posted as a message. PNG is deleted from the server after it's posted.

Wishlist

  • Edit already posted diagram (through Modal?)
  • Automatically detect Mermaid diagrams in messages and render them?
  • Live preview of the mermaid document in the modal? Seems like this can't be done with Slack's UI limitations.
  • Support DMs, more context in the comment.