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.

Sign up for GitHub

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

Jump to bottom

adding Markdown to SequenceDiagram Notes #5460

Open
darkedges opened this issue Apr 13, 2024 · 0 comments · May be fixed by #5461
Open

adding Markdown to SequenceDiagram Notes #5460

darkedges opened this issue Apr 13, 2024 · 0 comments · May be fixed by #5461
Labels
Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request

Comments

@darkedges
Copy link

Proposal

adding markdown to sequenceDiagram notes.
Using a package such as https://marked.js.org/ to help render the contents.
Can be extended to notes in general, by replacing the text renderer with this.

Open to other design ideas.

Example

sequenceDiagram
  participant am
  note left of am
  note left of am
     <markdown here>
     <markdown here>
     <markdown here>
  end

or

sequenceDiagram
  participant am
  note left of am["
     <markdown here>
     <markdown here>
     <markdown here>
  "]

Screenshots

image
@darkedges darkedges added Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request labels Apr 13, 2024
@darkedges darkedges changed the title adding Markdown to Sequence Notes adding Markdown to SequenceDiagram Notes Apr 13, 2024
darkedges added a commit to darkedges/mermaid that referenced this issue Apr 13, 2024
@darkedges
5460 - Initial Release for review
379da2b 
mermaid-js#5460
This adds Markdown support for SequenceDiagram notes
Needs cleanup.
@darkedges darkedges linked a pull request Apr 13, 2024 that will close this issue
Open
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

5460 - Initial Release for review darkedges/mermaid
1 participant
@darkedges