5460 - Initial Release for review

darkedges commented 2 months ago

https://github.com/mermaid-js/mermaid/issues/5460 This adds Markdown support for SequenceDiagram notes Needs cleanup.

:bookmark_tabs: Summary

This adds Markdown support for notes and syntax highlighting.

Resolves #5460

:straight_ruler: Design Decisions

Updates the Parser to include support dor multline end support. Detects if it fins Markdown and uses the Markdown renderer to geneate text. Follows the same pattern as katexsupport.

:clipboard: Tasks

Make sure you

[x ] :book: have read the contribution guidelines
[ ] :computer: have added necessary unit/e2e tests.
[ ] :notebook: have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
[ x] :bookmark: targeted develop branch

netlify[bot] commented 2 months ago

Deploy Preview for mermaid-js ready!

Name	Link
Latest commit	ecfe14adc192f453e285bbba13ad8c2b8cd57d9d
Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/661d96848e8c4d000859a8b7
Deploy Preview	https://deploy-preview-5461--mermaid-js.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

darkedges commented 2 months ago

I need some help cleaning up the parser as that is currently breaking checkins.

Conflict in grammar: multiple actions possible when lookahead token is TXT in state 116
- reduce by rule: note_section -> 
- shift token (then go to state 120)

States with conflicts:
State 116
  note_statement -> note placement actor .text2 #lookaheads= NEWLINE
  note_statement -> note placement actor .note_section end #lookaheads= NEWLINE
  text2 -> .TXT
  note_section -> . #lookaheads= end ACTOR TXT NEWLINE
  note_section -> .note_section note_line #lookaheads= end ACTOR TXT NEWLINE
Conflict in grammar: multiple actions possible when lookahead token is TXT in state 116
- reduce by rule: note_section ->
- shift token (then go to state 120)

States with conflicts:
State 116
  note_statement -> note placement actor .text2 #lookaheads= NEWLINE
  note_statement -> note placement actor .note_section end #lookaheads= NEWLINE
  text2 -> .TXT
  note_section -> . #lookaheads= end ACTOR TXT NEWLINE
  note_section -> .note_section note_line #lookaheads= end ACTOR TXT NEWLINE

also need to include the css requied for highligthing.

mermaid-js / mermaid