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

Render graphs in README.md #917

Open
monsterbitar opened this issue Oct 18, 2024 · 2 comments
Open

Render graphs in README.md #917

monsterbitar opened this issue Oct 18, 2024 · 2 comments

Comments

@monsterbitar
Copy link

Is your feature request related to a problem? Please describe.
I am trying to add an explanation for a state based setup on the main landing page of the documentation, which pulls its content from the README.md file. I tried copying over the the mermaid codeblock that works when used in some of my event documentation, but it does not get rendered as a graph on the landing page.

The graph is encapsulated as a mermaid code block, rather than as a mermaid typedoc tag.

Describe the solution you'd like
I would like the landing page to also render my mermaid chart.

Describe alternatives you've considered
I have not considered any alternatives.

@schalkventer
Copy link

+1 for this. Would be great to have! Might even look at doing a PR for this if I get some time to look into it.

@sookah
Copy link

sookah commented Feb 4, 2025

Same issue for me I have several .md files that have mermaid in them, would be great to have it

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

No branches or pull requests

3 participants