docs: correct mermaid docs after upgrade marked #2490
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Hi @Koooooo-7 , thanks so much for identifying this issue! I've been using the Mermaid plugin (https://github.com/Leward/mermaid-docsify which seems to support v10) so I did not even know of any support of Mermaid was possible in Docsify itself🙂
Happy to help tweak the updated docs, here is a first pass:
## Limited Support of mermaid
!> Currently, docsify only supports mermaid version `v9.3.0` (as the async render in mermaid `v10.x` is not yet supported in docsify)
I also have a preview build with this change for you to see:
https://paulhibbitts.github.io/docsify-v5-preview/#/markdown?id=limited-support-of-mermaid
And tried an example Mermaid 9.x diagram🙂
https://paulhibbitts.github.io/docsify-v5-preview/#/test-5
PS - I think I will also exploring moving over to this built-in support with Docsify-This
|
Btw what happens with latest mermaid? Is there an error or something? |
sy-records
changed the title
The mermaid makes a breaking change that it only support the async render after > v9.3, but we use the |
Summary
correct mermaid docs after upgrade marked, and mentioned its limitation.
We should adoption the mermaid to resolve the async issue in #1433 then.
Related issue, if any:
What kind of change does this PR introduce?
Docs
For any code change,
Does this PR introduce a breaking change?
Yes
No
Tested in the following browsers: