Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Request: Mermaid Code Rendering #27924

Closed
us254 opened this issue May 16, 2024 · 1 comment
Closed

Request: Mermaid Code Rendering #27924

us254 opened this issue May 16, 2024 · 1 comment

Comments

@us254
Copy link

us254 commented May 16, 2024

Is your feature request related to a problem?

Yes, the current limitation of not being able to render Mermaid code directly within the platform hampers the ability to visualize and document complex workflows, diagrams, and charts. This reduces the effectiveness of documentation and collaboration.The inability to render Mermaid code means users cannot leverage the power of visual diagrams to enhance their documentation. This can lead to misunderstanding, miscommunication, and an overall less effective documentation and collaboration process.

Describe the solution you'd like

I would like the platform to support Mermaid code rendering. When Mermaid code is enclosed with triple backticks and prefixed with mermaid, the platform should automatically convert the code into a rendered diagram.
Example:

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D; 

The above code should render a diagram showing the flow from A to B and C, and from B and C to D.

Describe alternatives you've considered

  1. Manually Embedding Diagrams: Users could manually create and embed images of diagrams. However, this approach is less dynamic and makes updates cumbersome. Additionally, it doesn't allow for easy textual revisions within the platform.
  2. External Diagram Tools: Users can utilize external tools like draw.io or Lucidchart and then embed the images. This, however, creates dependency on third-party tools and disrupts the workflow.

Additional context
Implementing Mermaid code rendering will:

  • Enable users to create and share detailed diagrams directly in their documentation, improving clarity and understanding.
  • Facilitate improved team collaboration by providing visual representations of workflows.
  • Provide consistency with other platforms like GitHub, which already supports Mermaid rendering, thus offering a seamless user experience.

Your consideration of this feature request would greatly enhance the platform's utility and user satisfaction.

Thank you!

@Aokromes
Copy link
Collaborator

platform wide bugs / requests belongs to https://bugs.telegram.org/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants