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

Feature: [MD049] Ignores style of TableOfContent #298

Closed
cloudy81 opened this issue Sep 6, 2023 · 3 comments
Closed

Feature: [MD049] Ignores style of TableOfContent #298

cloudy81 opened this issue Sep 6, 2023 · 3 comments
Labels

Comments

@cloudy81
Copy link

cloudy81 commented Sep 6, 2023

When using Markdown files for azure devops we need to add table of content with following style
image

But the check of MD049 shows than inconstancy
image

Is it possible to ignore table of content for check

@cloudy81
Copy link
Author

cloudy81 commented Sep 6, 2023

@DavidAnson I have seen the same question here.

I tried also to suppress it
image

Would be nice to have a solution for that
Maybe a possibility to ignore a line
image

@DavidAnson
Copy link
Owner

This is a duplicate as you point out. Also, <!-- markdownlint-disable-next-line --> already exists: https://github.com/DavidAnson/markdownlint#configuration

@DavidAnson
Copy link
Owner

Actually, it's not a duplicate issue because the issue you link to above is about parsing before the table of contents is inserted and yours seems to be about parsing after it is inserted. From what I see of your example, the ability to disable rules for the next line will not be helpful here because you are examining code after the expansion and it contains multiple lines. In your case, the issues reported are correct that the emphasis style of asterisk is being used. If you have previously used the underscore style, then this is legitimately inconsistent. You could standardize on the asterisk form instead, change the TOC generator to produce underscores in the table of contents, or disable this rule for that part of the document or for your project.

@DavidAnson DavidAnson closed this as not planned Won't fix, can't repro, duplicate, stale Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants