-
Notifications
You must be signed in to change notification settings - Fork 188
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
Setup Mermaid for Docusaurus #3150
Conversation
* Configuration for Mermaid in Docusaurus
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've been waiting for this! You have no idea.
After following your steps, I added
```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
to src/docs/docs/overview.md
just to test it out and it worked!
I can finally unblock #2880 now
If we want to make a graph, there is a keyword |
@tcvan0707 thank you for throwing those information in. That absolutely help me if I want to contribute in the future ! |
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.
Very useful!
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.
Nice feature
Issue This PR Addresses
Fixes issue #2960
Type of Change
Description
This PR is going to set up Mermaid for our Docusaurus. The picture below is a sample to proof that Mermaid is working in our docs
Steps to test the PR
src/docs
:cd src/docs/
pnpm start
localhost:4631
on the web browserChecklist