starred/markdownlint

Fork 0

mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-04-25 17:26:22 +03:00

[GH-ISSUE #940] MD051 - files in repo/gist #561

New issue

Closed

opened 2026-03-03 01:28:01 +03:00 by kerem · 4 comments

kerem commented

2026-03-03 01:28:01 +03:00

Owner

Originally created by @anonymous1184 on GitHub (Aug 26, 2023).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/940

The rule triggers files in the same repo/gist.

Example README.md:

[Self][1]

[1]: #file-readme-md

Originally created by @anonymous1184 on GitHub (Aug 26, 2023). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/940 The rule triggers files in the same repo/gist. Example `README.md`: ![image](https://github.com/DavidAnson/markdownlint/assets/53758552/b7d20f8c-3f7d-4cfb-b957-95568449dc4a) ```md [Self][1] [1]: #file-readme-md ```

kerem

2026-03-03 01:28:01 +03:00

closed this issue
added the
question
label

kerem commented

2026-03-03 01:28:02 +03:00

Author

Owner

@DavidAnson commented on GitHub (Aug 26, 2023):

That is correct, none of the automatically generated fragments in that file match "file-readme-md".

The rule documentation explains more: https://github.com/DavidAnson/markdownlint/blob/main/doc/md051.md

If you change the top level heading to "File README MD", the warning goes away because that creates a matching fragment: https://dlaa.me/markdownlint/#%25m%23%20File%20README%20MD%0A%0A%5BSelf%5D%5B1%5D%0A%0A%5B1%5D%3A%20%23file-readme-md%0A

@DavidAnson commented on GitHub (Aug 26, 2023): That is correct, none of the automatically generated fragments in that file match "file-readme-md". The rule documentation explains more: https://github.com/DavidAnson/markdownlint/blob/main/doc/md051.md If you change the top level heading to "File README MD", the warning goes away because that creates a matching fragment: https://dlaa.me/markdownlint/#%25m%23%20File%20README%20MD%0A%0A%5BSelf%5D%5B1%5D%0A%0A%5B1%5D%3A%20%23file-readme-md%0A

kerem commented

2026-03-03 01:28:02 +03:00

Author

Owner

@anonymous1184 commented on GitHub (Aug 26, 2023):

I know, but is a valid link in GitHub and other VCS sites.

Here's an example: https://gist.github.com/64fe98f2d25c8faaeea11ebae7bf1014

Perhaps a configuration to allow this kind of links?

@anonymous1184 commented on GitHub (Aug 26, 2023): I know, but is a valid link in GitHub and other VCS sites. Here's an example: <https://gist.github.com/64fe98f2d25c8faaeea11ebae7bf1014> Perhaps a configuration to allow this kind of links?

kerem commented

2026-03-03 01:28:02 +03:00

Author

Owner

@DavidAnson commented on GitHub (Aug 26, 2023):

If you are saying any link fragment could potentially be valid, then you do not want any of them to trigger a warning and so you can disable rule MD051 for that file or for your project.

@DavidAnson commented on GitHub (Aug 26, 2023): If you are saying any link fragment could potentially be valid, then you do not want any of them to trigger a warning and so you can disable rule MD051 for that file or for your project.

kerem commented

2026-03-03 01:28:02 +03:00

Author

Owner

@anonymous1184 commented on GitHub (Aug 26, 2023):

I was thinking more about an exception for query fragments starting in file-, as most (if not all) of the VCS sites use it.

I basically only write in MD, so the extension is a must for me... super practical and highly configurable (I have projects with tabs, 2/4 spaces for indentation, some that require HTML tags, some that don't, etc...).

If there is no way to add it, I can ignore the warnings or disable it per-file () once I'm sure all the other links are good to go.

Thanks a lot for this useful tool and your time.

@anonymous1184 commented on GitHub (Aug 26, 2023): I was thinking more about an exception for query fragments starting in `file-`, as most (if not all) of the VCS sites use it. I basically only write in MD, so the extension is a **must** for me... super practical and highly configurable (I have projects with tabs, 2/4 spaces for indentation, some that require HTML tags, some that don't, etc...). If there is no way to add it, I can ignore the warnings or disable it per-file (``) once I'm sure all the other links are good to go. Thanks a lot for this useful tool and your time.

kerem referenced this issue

2026-03-03 01:30:40 +03:00

[PR #561] [MERGED] Bump eslint-plugin-unicorn from 42.0.0 to 43.0.2 #896

kerem referenced this issue

2026-03-07 20:10:22 +03:00

[PR #561] [MERGED] Bump eslint-plugin-unicorn from 42.0.0 to 43.0.2 #2744