-
-
Notifications
You must be signed in to change notification settings - Fork 6.8k
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
Fix highlight #5903
base: master
Are you sure you want to change the base?
Fix highlight #5903
Conversation
|
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why can't we use shiki to detect mermaid-example as an alias for mermaid?
```mermaid | ||
zenuml | ||
Alice->Bob: Hello Bob, how are you? | ||
Bob->Alice: Not so good :( | ||
opt { | ||
Bob->Alice: Thanks for asking | ||
} | ||
``` | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The mermaid code is present for github to render the diagram, and the mermaid-example is present to show the code. Please don't remove the mermaid blocks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I intended to only change the mermaid-example to mmd.
but the highliht is still not working, I changed this to draft for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
openned an issue to solve the problem. shikijs/textmate-grammars-themes#93
📑 Summary
fix lack of code highlight
📏 Design Decisions
mermaid-example is bad as an alias for mermaid language highligth as reviewer by the shiki maintainer. Using mmd instead.
📋 Tasks
🚧 This only changes de docs so I didn't run the tests and building process!
Make sure you
MERMAID_RELEASE_VERSION
is used for all new features.pnpm changeset
and following the prompts. Changesets that add features should beminor
and those that fix bugs should bepatch
. Please prefix changeset messages withfeat:
,fix:
, orchore:
.