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

Fix highlight #5903

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Conversation

emersonbottero
Copy link
Contributor

@emersonbottero emersonbottero commented Sep 27, 2024

📑 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

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Copy link

changeset-bot bot commented Sep 27, 2024

⚠️ No Changeset found

Latest commit: 1fca8a4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Sep 27, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 1fca8a4
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/66f60cff62aa360008aee83d
😎 Deploy Preview https://deploy-preview-5903--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

argos-ci bot commented Sep 27, 2024

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ⚠️ Changes detected (Review) 9 changed Sep 27, 2024, 1:51 AM

Copy link
Member

@sidharthv96 sidharthv96 left a 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?

Comment on lines -379 to -387
```mermaid
zenuml
Alice->Bob: Hello Bob, how are you?
Bob->Alice: Not so good :(
opt {
Bob->Alice: Thanks for asking
}
```

Copy link
Member

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.

Copy link
Contributor Author

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.

Copy link
Contributor Author

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

@emersonbottero emersonbottero marked this pull request as draft September 28, 2024 14:30
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

Successfully merging this pull request may close these issues.

2 participants