Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFC: stop using markdown-it-attrs by default #45

Open
d3m1d0v opened this issue Feb 20, 2025 · 0 comments
Open

RFC: stop using markdown-it-attrs by default #45

d3m1d0v opened this issue Feb 20, 2025 · 0 comments
Assignees
Labels
RFC Request for Comments

Comments

@d3m1d0v
Copy link
Member

d3m1d0v commented Feb 20, 2025

Description

There are several important issues when using markdown-it-attrs plugin:

But some of our extensions assume the use of attribute syntax {} and expect attributes to be automatically parsed.

Proposal

I suggest stop using markdown-it-attrs plugin by default in transformer. Extensions should parse attributes for themselves. Utils package already has a custom parser for attributes.

Plan

  1. Use AttrsParser from @diplodoc/utils in extensions
  2. Add option to transformer to disable markdown-it-attrs plugin
    • enableMarkdownAttrs option with default value true
  3. In next transformer major version disable markdown-it-attrs plugin by default
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RFC Request for Comments
Projects
None yet
Development

No branches or pull requests

1 participant