mermaid-preview's Introduction

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.

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.

mermaid-preview's People

Contributors

Stargazers

Watchers

mermaid-preview's Issues

mermaid-preview says flowchart diagram is invalid

I've just tried mermaid-preview for the first time. It doesn't seem to support the flowchart diagram. I've used the following sample diagram from Mermaid.live:

flowchart TD
    A[Christmas] -->|Get money| B(Go shopping)
    B --> C{Let me think}
    C -->|One| D[Laptop]
    C -->|Two| E[iPhone]
    C -->|Three| F[fa:fa-car Car]

I get a message back that says "Mermaid diagram is invalid."

App is not approved by Slack.

Can not add the app to Slack, since it is not approved by Slack

Support /mermaid in threads

I tried to use /mermaid in a thread today but Slackbot let me know that it doesn't work in threads. Is this easy to implement?

How do you use it in a private channel?

I tried using /mermaid in a private channel, but it shows Mermaid Preview can't automatically join private channels. If it's a private channel, please invite Mermaid bot to it.. I tried adding the Mermaid bot to the channel; however, it doesn't show up on the participants list.

How do I use it in a private channel?

Recommend Projects