docs: add markdown renderer migration guide for v4 to v5#2707
docs: add markdown renderer migration guide for v4 to v5#2707vincent067 wants to merge 1 commit intodocsifyjs:developfrom
Conversation
Adds documentation for migrating custom markdown renderer overrides from v4 to v5. The window..markdown option is deprecated in v5, so this guide provides alternative approaches using: 1. marked extensions (recommended) 2. Docsify plugins with custom renderers Closes docsifyjs#2680
|
Someone is attempting to deploy a commit to the Docsify Team on Vercel. A member of the Team first needs to authorize it. |
|
Hi @sy-records , when convenient could you please approve the vercel deployment and I will do a review, thanks! |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
sy-records
requested review from
Copilot and
paulhibbitts
and removed request for
Copilot
| window.$docsify = { | ||
| marked: { | ||
| extensions: [markedFootnote()], // Register the extension | ||
| }, | ||
| }; |
There was a problem hiding this comment.
This doesn't seem right; when I tested it, the footnote didn't work.
paulhibbitts
left a comment
paulhibbitts
left a comment
There was a problem hiding this comment.
I've also had no luck with a codesandbox using the following:
marked:
extensions: [markedFootnote()], // Register the extension
},
https://codesandbox.io/p/sandbox/kg72hc
Perhaps I am doing something wrong @vincent067 ?
sy-records
added
the
wait for information
| #### Key Changes | ||
|
|
||
| - ✅ Docsify v5 uses **marked v13+** with a hooks-based architecture | ||
| - ✅ The `window.$docsify.markdown` config option is **deprecated** |
There was a problem hiding this comment.
Indeed, that message was mistakenly included in an earlier RC and should no longer be present. Sorry for any confusion it may have caused.
3 participants
Summary
This PR adds documentation for migrating custom markdown renderer overrides from v4 to v5, addressing issue #2680.
Problem
Users upgrading from v4 to v5 who were using the
window.$docsify.markdownconfiguration option to customize the marked renderer found that their configuration was being ignored in v5. This is because Docsify v5 uses marked v13+, which has a different architecture and the old configuration approach is no longer supported.Solution
Added a new section
Migrating Custom Markdown Renderer Overridestov5-upgrade.mdthat documents:Changes
## Migrating Custom Markdown Renderer Overridessection todocs/v5-upgrade.mdRelated Issues
Closes #2680
Checklist
Thanks for maintaining Docsify! Happy to make any adjustments if needed. 😊