[GH-ISSUE #50] MD044 - Links and code should be excluded from checks #41

Closed
opened 2026-03-03 01:23:15 +03:00 by kerem · 5 comments
Owner

Originally created by @flodolo on GitHub (Mar 17, 2017).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/50

First of all, thanks for this great tool. I've been experimenting with it for the last couple of days and it works great.

I'm really interested in this rule, but it fails short with its current implementation. Example:

  "proper-names": {
      "names": [
          "GitHub"
      ]
  }

All docs fail where there's a link to GitHub. I think there should be an option to exclude links, URLs, and code from this check, and it should probably be true by default.

Originally created by @flodolo on GitHub (Mar 17, 2017). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/50 First of all, thanks for this great tool. I've been experimenting with it for the last couple of days and it works great. I'm really interested in this rule, but it fails short with its current implementation. Example: ``` "proper-names": { "names": [ "GitHub" ] } ``` All docs fail where there's a link to GitHub. I think there should be an option to exclude links, URLs, and code from this check, and it should probably be true by default.
kerem 2026-03-03 01:23:15 +03:00
Author
Owner

@DavidAnson commented on GitHub (Mar 17, 2017):

Please have a look at the tests for the following commit I made about an hour ago: github.com/DavidAnson/markdownlint@935935b96c

I think you will find it addresses exactly the issues you raise. :)

<!-- gh-comment-id:287281902 --> @DavidAnson commented on GitHub (Mar 17, 2017): Please have a look at the tests for the following commit I made about an hour ago: https://github.com/DavidAnson/markdownlint/commit/935935b96c4196df795fa8d2feb4870bbb13306d I think you will find it addresses exactly the issues you raise. :)
Author
Owner

@DavidAnson commented on GitHub (Mar 17, 2017):

Actually, it explicitly INcludes code - what is your scenario where that is not wanted?

<!-- gh-comment-id:287282053 --> @DavidAnson commented on GitHub (Mar 17, 2017): Actually, it explicitly INcludes code - what is your scenario where that is not wanted?
Author
Owner

@flodolo commented on GitHub (Mar 17, 2017):

Please have a look at the tests for the following commit I made about an hour ago: 935935b

Ah, that's great.

Actually, it explicitly INcludes code - what is your scenario where that is not wanted?

For example an HTML code fragment that includes links. It would also be great to ignore bare URLs, not just properly formatted links.

<!-- gh-comment-id:287282979 --> @flodolo commented on GitHub (Mar 17, 2017): > Please have a look at the tests for the following commit I made about an hour ago: 935935b Ah, that's great. > Actually, it explicitly INcludes code - what is your scenario where that is not wanted? For example an HTML code fragment that includes links. It would also be great to ignore bare URLs, not just properly formatted links.
Author
Owner

@DavidAnson commented on GitHub (Mar 17, 2017):

I'll probably allow excluding code, thanks.

I debated whether to special case bare URLs already - why not use a proper link instead?

<!-- gh-comment-id:287393871 --> @DavidAnson commented on GitHub (Mar 17, 2017): I'll probably allow excluding code, thanks. I debated whether to special case bare URLs already - why not use a proper link instead?
Author
Owner

@flodolo commented on GitHub (Mar 17, 2017):

I debated whether to special case bare URLs already - why not use a proper link instead?

I guess mostly for lazyness. If you want to write https://atom.io/, it's easier to use the bare URL than writing [https://atom.io/](https://atom.io, especially if you want to display the URL.

<!-- gh-comment-id:287396000 --> @flodolo commented on GitHub (Mar 17, 2017): > I debated whether to special case bare URLs already - why not use a proper link instead? I guess mostly for lazyness. If you want to write https://atom.io/, it's easier to use the bare URL than writing `[https://atom.io/](https://atom.io`, especially if you want to display the URL.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/markdownlint#41
No description provided.