mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2026-04-25 01:05:55 +03:00
[GH-ISSUE #734] MD049: Incorrectly detecting [[_TOC_]] #2374
Labels
No labels
bug
enhancement
enhancement
enhancement
fixed in next
fixed in next
fixed in next
new rule
new rule
new rule
pull-request
question
refactoring
refactoring
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
starred/markdownlint#2374
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @Prefix42 on GitHub (Mar 3, 2023).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/734
Problem Description
Rule MD049 incorrectly detects the the Azure Devops markdown tag to auto generate a table of contents
Issue
Azure Devops uses the tag
[[_TOC_]]to auto generate a table of contents at render. The tag must match case and syntax exactly or will be rendered as the litteral text. As the tag uses a prefix and suffix of underscore (_) the rule MD049 incorrectly detects the use of underscore as the emphasis style of the document.Proposal
Exclude "[[TOC]]" from emphasis evaluation
Impacted version(s)
v0.27.0
Supporting Documentation
Markdown syntax for wikis
@DavidAnson commented on GitHub (Mar 3, 2023):
This construct is not part of the CommonMark specification, so it is reasonable for it to be flagged. That said, your example does not seem to generate a violation: https://dlaa.me/markdownlint/#%25m%23%20Issue%20734%0A%0A%5B%5B_TOC_%5D%5D%0A
@Prefix42 commented on GitHub (Mar 3, 2023):
Thank you for the super prompt response.
My apologies for the poor explanation and lack of example. Please see the following for a better demonstration of the issue.
https://dlaa.me/markdownlint/#%25m%23%20Issue%20734%0A%0A%5B%5B_TOC_%5D%5D%0A%0Afoo%0A_bar_%0A
In regards to being outside of the CommonMark specification I completely understand but figured it never hurts to ask,
@DavidAnson commented on GitHub (Mar 3, 2023):
Thank you! I don't like adding special cases for weird stuff like this, but I see why it's annoying in your scenario. I'll leave this open to think about.
@ElCuboNegro commented on GitHub (Jun 13, 2024):
Almost the same with wikilinks. they have a
foo [[bar]] foosyntax that is incorrectly flagged as MD052/reference-links-images