docs: correct mermaid docs after upgrade marked

docsifyjs / docsify

🃏 A magical documentation site generator.

https://docsify.js.org

MIT License

27.82k stars 5.68k forks source link

docs: correct mermaid docs after upgrade marked #2490

Closed Koooooo-7 closed 3 months ago

Koooooo-7 commented 3 months ago

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,

[x] Related documentation has been updated, if needed
[ ] Related tests have been added or updated, if needed

Does this PR introduce a breaking change?

Yes No

Tested in the following browsers:

[x] Chrome
[ ] Firefox
[ ] Safari
[ ] Edge

vercel[bot] commented 3 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docsify-preview	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 17, 2024 0:44am

trusktr commented 3 months ago

Btw what happens with latest mermaid? Is there an error or something?

Koooooo-7 commented 3 months ago

Btw what happens with latest mermaid? Is there an error or something?

The mermaid makes a breaking change that it only support the async render after > v9.3, but we use the marked in synchronization. Hence user can not simply replace the code render with async functions, it gonna get a wrong Promised.