Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-16 14:00:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Edit description of MD051/link-fragments to clarify that it implements the GitHub algorithm for creating section links (which converts to lowercase) (refs #591).

Browse source
This commit is contained in:
David Anson 2022-11-05 16:49:38 -07:00
parent 38ae54a27f
commit 30353cc733
3 changed files with 69 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

33
doc-build/md051.md
View file

@ -1,5 +1,5 @@
This rule is triggered when a link fragment does not correspond to a heading This rule is triggered when a link fragment does not match any of the fragments
in the document: that are automatically generated for headings in a document:
```markdown ```markdown
# Title # Title
@ -7,23 +7,36 @@ in the document:
[Link](#fragment) [Link](#fragment)
``` ```
To fix the issue, change the fragment to reference an existing heading: To fix this issue, change the link fragment to reference an existing heading:
```markdown ```markdown
# Title
[Link](#title) [Link](#title)
``` ```
Alternatively, an HTML `a` tag with an `id` (or a `name`) attribute defines a Alternatively, an HTML `a` tag with an `id` or a `name` attribute can be used to
valid anchor: define a fragment:
```markdown ```markdown
<a id="fragment"></a> <a id="bookmark"></a>
[Link](#bookmark)
``` ```
Some platforms (e.g., [GitHub][github-section-links]) automatically create HTML An `a` tag can be useful in scenarios where a heading is not appropriate or for
anchors for every heading. This makes it easy to link to different sections in control over the text of the fragment identifier.
a document. These internal links can break over time as headings are renamed.
Note: Creating anchors for headings is not part of the CommonMark specification. Rationale: [GitHub section links][github-section-links] are created automatically
for every heading when Markdown content is displayed on GitHub. This makes it
easy to link directly to different sections within a document. However, section
links change if headings are renamed or removed. This rule helps identify broken
section links within a document.
Section links are **not** part of the CommonMark specification. This rule
enforces the [GitHub heading algorithm][github-heading-algorithm] which is:
convert heading to lowercase, remove punctuation, convert spaces to dashes, append
an incrementing integer as needed for uniqueness.
[github-section-links]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links [github-section-links]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links
[github-heading-algorithm]: https://github.com/gjtorikian/html-pipeline/blob/main/lib/html/pipeline/toc_filter.rb

33
doc/Rules.md
View file

@ -2077,8 +2077,8 @@ Tags: `links`
Aliases: `link-fragments` Aliases: `link-fragments`
This rule is triggered when a link fragment does not correspond to a heading This rule is triggered when a link fragment does not match any of the fragments
in the document: that are automatically generated for headings in a document:
```markdown ```markdown
# Title # Title
@ -2086,26 +2086,39 @@ in the document:
[Link](#fragment) [Link](#fragment)
``` ```
To fix the issue, change the fragment to reference an existing heading: To fix this issue, change the link fragment to reference an existing heading:
```markdown ```markdown
# Title
[Link](#title) [Link](#title)
``` ```
Alternatively, an HTML `a` tag with an `id` (or a `name`) attribute defines a Alternatively, an HTML `a` tag with an `id` or a `name` attribute can be used to
valid anchor: define a fragment:
```markdown ```markdown
<a id="fragment"></a> <a id="bookmark"></a>
[Link](#bookmark)
``` ```
Some platforms (e.g., [GitHub][github-section-links]) automatically create HTML An `a` tag can be useful in scenarios where a heading is not appropriate or for
anchors for every heading. This makes it easy to link to different sections in control over the text of the fragment identifier.
a document. These internal links can break over time as headings are renamed.
Note: Creating anchors for headings is not part of the CommonMark specification. Rationale: [GitHub section links][github-section-links] are created automatically
for every heading when Markdown content is displayed on GitHub. This makes it
easy to link directly to different sections within a document. However, section
links change if headings are renamed or removed. This rule helps identify broken
section links within a document.
Section links are **not** part of the CommonMark specification. This rule
enforces the [GitHub heading algorithm][github-heading-algorithm] which is:
convert heading to lowercase, remove punctuation, convert spaces to dashes, append
an incrementing integer as needed for uniqueness.
[github-section-links]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links [github-section-links]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links
[github-heading-algorithm]: https://github.com/gjtorikian/html-pipeline/blob/main/lib/html/pipeline/toc_filter.rb
<a name="md052"></a> <a name="md052"></a>

33
doc/md051.md
View file

@ -4,8 +4,8 @@ Tags: `links`
Aliases: `link-fragments` Aliases: `link-fragments`
This rule is triggered when a link fragment does not correspond to a heading This rule is triggered when a link fragment does not match any of the fragments
in the document: that are automatically generated for headings in a document:
```markdown ```markdown
# Title # Title
@ -13,23 +13,36 @@ in the document:
[Link](#fragment) [Link](#fragment)
``` ```
To fix the issue, change the fragment to reference an existing heading: To fix this issue, change the link fragment to reference an existing heading:
```markdown ```markdown
# Title
[Link](#title) [Link](#title)
``` ```
Alternatively, an HTML `a` tag with an `id` (or a `name`) attribute defines a Alternatively, an HTML `a` tag with an `id` or a `name` attribute can be used to
valid anchor: define a fragment:
```markdown ```markdown
<a id="fragment"></a> <a id="bookmark"></a>
[Link](#bookmark)
``` ```
Some platforms (e.g., [GitHub][github-section-links]) automatically create HTML An `a` tag can be useful in scenarios where a heading is not appropriate or for
anchors for every heading. This makes it easy to link to different sections in control over the text of the fragment identifier.
a document. These internal links can break over time as headings are renamed.
Note: Creating anchors for headings is not part of the CommonMark specification. Rationale: [GitHub section links][github-section-links] are created automatically
for every heading when Markdown content is displayed on GitHub. This makes it
easy to link directly to different sections within a document. However, section
links change if headings are renamed or removed. This rule helps identify broken
section links within a document.
Section links are **not** part of the CommonMark specification. This rule
enforces the [GitHub heading algorithm][github-heading-algorithm] which is:
convert heading to lowercase, remove punctuation, convert spaces to dashes, append
an incrementing integer as needed for uniqueness.
[github-section-links]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links [github-section-links]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links
[github-heading-algorithm]: https://github.com/gjtorikian/html-pipeline/blob/main/lib/html/pipeline/toc_filter.rb