starred/markdownlint

Fork 0

mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-04-25 09:16:02 +03:00

#102

New issue

Open

opened 2026-03-03 01:23:44 +03:00 by kerem · 8 comments

kerem commented

2026-03-03 01:23:44 +03:00

Owner

Originally created by @nschonni on GitHub (May 23, 2018).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/121

I've been using https://github.com/tcort/markdown-link-check/ as a separate check to validate links in markdown. I was starting to see if I could leverage the .markdownlint.json as a config format for that project too and realized maybe it might make sense to just add that functionality as a rule in this project.
Because it can go out and create network requests, I think having it off by default would make sense.
I may just do it as a custom rule in the end, but I figured I'd check to see if there is interest in this as a core rule.

Example config schema:

    "valid-links": {
      "description": "MD###/valid-links - Validate links",
      "type": [
        "boolean",
        "object"
      ],
      "default": true,
      "properties": {
        "link_types": {
          "description": "Types of links to validate",
          "type": "string",
          "enum": [
            "all",
            "internal",
            "external"
          ],
          "default": "internal"
        },
        "ignore_patterns": {
          "description": "RegExp for ignoring links",
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": []
        },
        "http_headers": {
          "description": "Url and HTTP header pairs when URLs need additional parameters",
          "type": "array",
          "items": {
            "type": "object"
          },
          "default": []
      },
      "additionalProperties": false

/cc @tcort @timmkrause

Originally created by @nschonni on GitHub (May 23, 2018). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/121 I've been using https://github.com/tcort/markdown-link-check/ as a separate check to validate links in markdown. I was starting to see if I could leverage the `.markdownlint.json` as a config format for that project too and realized maybe it might make sense to just add that functionality as a rule in this project. Because it can go out and create network requests, I think having it off by default would make sense. I may just do it as a custom rule in the end, but I figured I'd check to see if there is interest in this as a core rule. Example config schema: ```json "valid-links": { "description": "MD###/valid-links - Validate links", "type": [ "boolean", "object" ], "default": true, "properties": { "link_types": { "description": "Types of links to validate", "type": "string", "enum": [ "all", "internal", "external" ], "default": "internal" }, "ignore_patterns": { "description": "RegExp for ignoring links", "type": "array", "items": { "type": "string" }, "default": [] }, "http_headers": { "description": "Url and HTTP header pairs when URLs need additional parameters", "type": "array", "items": { "type": "object" }, "default": [] }, "additionalProperties": false ``` /cc @tcort @timmkrause

kerem added the

new rule

label

2026-03-03 01:23:44 +03:00

kerem commented

2026-03-03 01:23:45 +03:00

Author

Owner

@DavidAnson commented on GitHub (May 23, 2018):

Love the idea! This comes up from time to time, so definitely worth thinking about. I think it would be pretty straightforward to implement as a custom rule, especially because the parser will have already pulled out each of the URLs.

What I’d like to do is start everything as a custom rule, see how it does, then look at pulling successful ones into the core library. (With the caveat that I try hard to avoid new dependencies, so maybe attempt this using only the core Node.js modules.)

If you prototype something here, I'd be happy to answer any questions that come up!

(See also https://github.com/DavidAnson/check-pages for a project of mine that checks links.)

@DavidAnson commented on GitHub (May 23, 2018): Love the idea! This comes up from time to time, so definitely worth thinking about. I think it would be pretty straightforward to implement as a custom rule, especially because the parser will have already pulled out each of the URLs. What I’d like to do is start everything as a custom rule, see how it does, then look at pulling successful ones into the core library. (With the caveat that I try hard to avoid new dependencies, so maybe attempt this using only the core Node.js modules.) If you prototype something here, I'd be happy to answer any questions that come up! (See also https://github.com/DavidAnson/check-pages for a project of mine that checks links.)

kerem commented

2026-03-03 01:23:45 +03:00

Author

Owner

@nschonni commented on GitHub (May 23, 2018):

Sounds good, I'll see if I can figure out setting up a separate rule repo.
Any advice on naming conventions and namespacing for rules, just to avoid any future issues if you decide it would fit in core?

@nschonni commented on GitHub (May 23, 2018): Sounds good, I'll see if I can figure out setting up a separate rule repo. Any advice on naming conventions and namespacing for rules, just to avoid any future issues if you decide it would fit in core?

kerem commented

2026-03-03 01:23:45 +03:00

Author

Owner

@DavidAnson commented on GitHub (May 23, 2018):

Don’t assign an MDxxx name, just use a name like validate-links and it should be possible to pull it in pretty much as-is. Some other guidance here: https://github.com/DavidAnson/markdownlint/blob/master/doc/CustomRules.md

@DavidAnson commented on GitHub (May 23, 2018): Don’t assign an MDxxx name, just use a name like validate-links and it should be possible to pull it in pretty much as-is. Some other guidance here: https://github.com/DavidAnson/markdownlint/blob/master/doc/CustomRules.md

kerem commented

2026-03-03 01:23:45 +03:00

Author

Owner

@amimas commented on GitHub (Feb 16, 2020):

Just wanted share my experience. I'm using both markdownlint-cli and textlint in my documentation projects. The following rule in textlint takes care of link validation:

https://github.com/textlint-rule/textlint-rule-no-dead-link

@amimas commented on GitHub (Feb 16, 2020): Just wanted share my experience. I'm using both markdownlint-cli and textlint in my documentation projects. The following rule in textlint takes care of link validation: https://github.com/textlint-rule/textlint-rule-no-dead-link

kerem commented

2026-03-03 01:23:45 +03:00

Author

Owner

@borekb commented on GitHub (Nov 16, 2020):

Just going to note that even a subset of this feature, which would be checking local links like see [below](#another-heading) would be quite useful.

@borekb commented on GitHub (Nov 16, 2020): Just going to note that even a subset of this feature, which would be **checking local links** like `see [below](#another-heading)` would be quite useful.

kerem commented

2026-03-03 01:23:45 +03:00

Author

Owner

@DavidAnson commented on GitHub (Jun 1, 2022):

Upcoming rule MD051 will implement this behavior for local links (#something).

github.com/DavidAnson/markdownlint@33ee1cd85e

@DavidAnson commented on GitHub (Jun 1, 2022): Upcoming rule MD051 will implement this behavior for local links (#something). https://github.com/DavidAnson/markdownlint/commit/33ee1cd85ee1eeaaca4ba4d7f18e7e2edf67a48d

kerem commented

2026-03-03 01:23:45 +03:00

Author

Owner

@theoludwig commented on GitHub (Jan 2, 2023):

Update: I published a new npm package to add this custom rule (validating "dead" relative links): https://github.com/theoludwig/markdownlint-rule-relative-links.
Contributions are welcome! 🤗

@theoludwig commented on GitHub (Jan 2, 2023): Update: I published a new npm package to add this custom rule (validating "dead" relative links): https://github.com/theoludwig/markdownlint-rule-relative-links. Contributions are welcome! :hugs:

kerem commented

2026-03-03 01:23:45 +03:00

Author

Owner

@igor-tsiglyar commented on GitHub (Jan 12, 2024):

FYI the markdownlint-rule-relative-links plugin has been updated to support links to anchors like MD051 does.

@igor-tsiglyar commented on GitHub (Jan 12, 2024): FYI the markdownlint-rule-relative-links plugin has been [updated](https://github.com/theoludwig/markdownlint-rule-relative-links/releases/tag/v2.2.0) to support links to anchors like MD051 does.

kerem referenced this issue

2026-03-07 20:02:33 +03:00

[GH-ISSUE #56] rule MD034 flags URL in fenced block as "bare url", unlike mdl #1895

kerem referenced this issue

2026-03-07 20:02:54 +03:00

[GH-ISSUE #102] MD024 triggers on same inner headers inside different top-level headers #1933