starred/markdownlint

Fork 0

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

[GH-ISSUE #321] Add rule to enforce links as reference links #275

New issue

Closed

opened 2026-03-03 01:25:19 +03:00 by kerem · 10 comments

kerem commented

2026-03-03 01:25:19 +03:00

Owner

Originally created by @mondeja on GitHub (Aug 25, 2020).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/321

As default deactivated. If active, raise error here:

I'm a paragraph with [a link](http://link-to-somewhere)

...but passes this:

I'm a paragraph with [a link][link-to-somewhere]

[link-to-somewhere]: http://link-to-somewhere

Originally created by @mondeja on GitHub (Aug 25, 2020). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/321 As default deactivated. If active, raise error here: ```markdown I'm a paragraph with [a link](http://link-to-somewhere) ``` ...but passes this: ```markdown I'm a paragraph with [a link][link-to-somewhere] [link-to-somewhere]: http://link-to-somewhere ```

kerem

2026-03-03 01:25:19 +03:00

closed this issue
added the
new rule
label

kerem commented

2026-03-03 01:25:20 +03:00

Author

Owner

@waldyrious commented on GitHub (Aug 25, 2020):

It would also be nice if this was configurable by the length of the URL — i.e. non-reference links shorter than N characters would not trigger this rule, with the default max length being 0.

@waldyrious commented on GitHub (Aug 25, 2020): It would also be nice if this was configurable by the length of the URL — i.e. non-reference links shorter than N characters would not trigger this rule, with the default max length being 0.

kerem commented

2026-03-03 01:25:20 +03:00

Author

Owner

@DavidAnson commented on GitHub (Aug 25, 2020):

Agree, I like the rule and the parameter suggestion.

@DavidAnson commented on GitHub (Aug 25, 2020): Agree, I like the rule and the parameter suggestion.

kerem commented

2026-03-03 01:25:20 +03:00

Author

Owner

@leetrout commented on GitHub (Aug 31, 2020):

@DavidAnson @mondeja Any interest in an additional rule to enforce correct style on reference links for at least one unit of whitespace after the colon?

This would fail:

[link-to-somewhere]:http://link-to-somewhere

This would pass:

[link-to-somewhere]: http://link-to-somewhere

@leetrout commented on GitHub (Aug 31, 2020): @DavidAnson @mondeja Any interest in an additional rule to enforce correct style on reference links for at least one unit of whitespace after the colon? This would fail: ```diff [link-to-somewhere]:http://link-to-somewhere ``` This would pass: ```diff [link-to-somewhere]: http://link-to-somewhere ```

kerem commented

2026-03-03 01:25:21 +03:00

Author

Owner

@DavidAnson commented on GitHub (Aug 31, 2020):

It doesn't seem required by the specification, but I agree that one space is stylistically preferred. This would be a reasonable rule.

@DavidAnson commented on GitHub (Aug 31, 2020): It doesn't seem required by the specification, but I agree that one space is stylistically preferred. This would be a reasonable rule.

kerem commented

2026-03-03 01:25:21 +03:00

Author

Owner

@leetrout commented on GitHub (Aug 31, 2020):

CommonMark deviates from this and says it is optional but it is mentioned explicitly in the original Daring Fireball docs:

Then, anywhere in the document, you define your link label like this, on a line by itself:

[id]: http://example.com/ "Optional Title Here"

That is:

Square brackets containing the link identifier (optionally indented from the left margin using up to three spaces);
followed by a colon;
followed by one or more spaces (or tabs);
followed by the URL for the link;
optionally followed by a title attribute for the link, enclosed in double or single quotes, or enclosed in parentheses.

@leetrout commented on GitHub (Aug 31, 2020): [CommonMark deviates from this](https://spec.commonmark.org/0.29/#link-reference-definition) and says it is optional but it is mentioned explicitly in the original [Daring Fireball](https://daringfireball.net/projects/markdown/syntax#link) docs: > Then, anywhere in the document, you define your link label like this, on a line by itself: > > `[id]: http://example.com/ "Optional Title Here"` > > That is: > > Square brackets containing the link identifier (optionally indented from the left margin using up to three spaces); > followed by a colon; > followed by one or more spaces (or tabs); > followed by the URL for the link; > optionally followed by a title attribute for the link, enclosed in double or single quotes, or enclosed in parentheses.

kerem commented

2026-03-03 01:25:21 +03:00

Author

Owner

@leetrout commented on GitHub (Aug 31, 2020):

Opened https://github.com/DavidAnson/markdownlint/issues/326

Sorry to interrupt this, but thanks for the quick answers!

@leetrout commented on GitHub (Aug 31, 2020): Opened https://github.com/DavidAnson/markdownlint/issues/326 Sorry to interrupt this, but thanks for the quick answers!

kerem commented

2026-03-03 01:25:21 +03:00

Author

Owner

@wolf99 commented on GitHub (Aug 27, 2022):

I would like this as an optional rule, either with or without the space.
(Though I prefer with the space)

@wolf99 commented on GitHub (Aug 27, 2022): I would like this as an optional rule, either with or without the space. (Though I prefer with the space)

kerem commented

2026-03-03 01:25:21 +03:00

Author

Owner

@wolf99 commented on GitHub (Oct 8, 2022):

Possible duplicate of #40 ?

@wolf99 commented on GitHub (Oct 8, 2022): Possible duplicate of #40 ?

kerem commented

2026-03-03 01:25:21 +03:00

Author

Owner

@leetrout commented on GitHub (Oct 8, 2022):