docs: add markdown renderer migration guide for v4 to v5#2707
Open
vincent067 wants to merge 1 commit intodocsifyjs:developfrom
Open
docs: add markdown renderer migration guide for v4 to v5#2707vincent067 wants to merge 1 commit intodocsifyjs:developfrom
vincent067 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. |
Member
|
Hi @sy-records , when convenient could you please approve the vercel deployment and I will do a review, thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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. 😊