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

Product Update: Mermaid Support #322

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

grossyoan
Copy link
Contributor

Hi there !

I wrote the Product Update for Mermaid this morning.
To do before merging:

  • Add a Mermaid tutorial in the help center
  • Add link to the help center in the demo doc and the PU.

Have a good day!

Copy link

netlify bot commented Jan 23, 2025

Deploy Preview for bump-content-hub ready!

Name Link
🔨 Latest commit 504f810
🔍 Latest deploy log https://app.netlify.com/sites/bump-content-hub/deploys/679252472e01a500087f6761
😎 Deploy Preview https://deploy-preview-322--bump-content-hub.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.

@grossyoan grossyoan requested review from jayk-u and paulRbr January 23, 2025 12:46
Copy link
Member

@paulRbr paulRbr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, however I think it lacks a sentence or some explanation about Markdown.

Even if it's trivial, users could get confused and I think we need to emphasis that this mermaid support is part of our global markdown support (i.e. mermaid diagrams need to live inside a markdown code block)

@grossyoan
Copy link
Contributor Author

grossyoan commented Jan 23, 2025

Looks good, however I think it lacks a sentence or some explanation about Markdown.

Even if it's trivial, users could get confused and I think we need to emphasis that this mermaid support is part of our global markdown support (i.e. mermaid diagrams need to live inside a markdown code block)

That's a good point!
It we add Mermaid in the Markdown page of the help center, it would allo to just add one link with the right anchor.

I changed the sentence to "The support of Mermaid is part of our global Markdown support. Learn more about it in our help center."

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