feat: add skipFootnoteLike option to inline span#29
Open
kermanx wants to merge 1 commit into
Open
Conversation
commit: |
6d75e99 to
a04be24
Compare
Adds a new option to mdc_inline_span that, when enabled, skips
footnote-like syntax [^...] to avoid conflicts with footnote plugins
(e.g. markdown-it-footnote).
By default, the option is false to preserve backward compatibility.
Usage:
md.use(MarkdownItMdc, { syntax: { inlineSpan: { skipFootnoteLike: true } } })
Fixes compatibility with slidev and other tools using footnotes
alongside Comark/MDC syntax.
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
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.
Adds a new option to mdc_inline_span that, when enabled, skips footnote-like syntax
[^...]to avoid conflicts with footnote plugins (e.g. markdown-it-footnote).By default, the option is
true, which makes this PR a minor breaking change.Usage:
Changes:
skipFootnoteLikeoption toMdcInlineSpanOptionsMarkdownItMdcto accept and pass options to inline span[^note]still treated as span)Related issue:
This fixes the footnote compatibility issue reported in slidevjs/slidev#2524.