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

Interactive documentation #5311

Closed
nalgeon opened this issue Feb 23, 2024 · 3 comments
Closed

Interactive documentation #5311

nalgeon opened this issue Feb 23, 2024 · 3 comments
Labels
Status: Triage Needs to be verified, categorized, etc

Comments

@nalgeon
Copy link
Contributor

nalgeon commented Feb 23, 2024

Hi folks! Thank you for this great project!

I think the Mermaid docs would be even better if the examples were interactive, so people could change the code and see it reflected in the diagram. Here is an example based on the Mermaid Intro: https://codapi.org/try/mermaid

If you're interested, I'll be happy to send you a PR to backport this into Mermaid Intro (and maybe Syntax docs as well).

@github-actions github-actions bot added the Status: Triage Needs to be verified, categorized, etc label Feb 23, 2024
@sidharthv96
Copy link
Member

Yes, that would be wonderful.
If we could avoid having to click on run, and auto render as people type (like mermaid.live), it might be smoother as well.

@nalgeon
Copy link
Contributor Author

nalgeon commented Mar 11, 2024

The maintainer changed their mind:

I feel that codapi is adding a lot of complexity for what can be achieved by a custom vue component which calls mermaid.render on a button click.

Closing.

@nalgeon nalgeon closed this as not planned Won't fix, can't repro, duplicate, stale Mar 11, 2024
@sidharthv96
Copy link
Member

I changed my mind based on the information presented.
The feature was implemented in #5376

Full explanation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Triage Needs to be verified, categorized, etc
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants