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

Update MD053/link-image-reference-definitions to add ignored_definitions parameter (default to ["//"]) (fixes #545).

Browse source
This commit is contained in:
David Anson 2022-08-02 20:36:47 -07:00
parent 2c3e8c938b
commit a6489acd6b
14 changed files with 234 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

15
doc/Rules.md
View file

@ -1315,7 +1315,7 @@ To fix this, use 'pure' Markdown instead of including raw HTML:
# Markdown heading
```
Note: To allow specific HTML elements, use the 'allowed_elements' parameter.
Note: To allow specific HTML elements, use the `allowed_elements` parameter.
Rationale: Raw HTML is allowed in Markdown, but this rule is included for
those who want their documents to only include "pure" Markdown, or for those
@ -2075,6 +2075,8 @@ Tags: images, links
Aliases: link-image-reference-definitions
Parameters: ignored_definitions (array of string; default [ "//" ])
Fixable: Most violations can be fixed by tooling
Links and images in Markdown can provide the link destination or image source
@ -2092,9 +2094,18 @@ unnecessary:
used and the others can be deleted.
This rule considers a reference definition to be used if any link or image
reference has the corresponding label. "Full", "collapsed", and "shortcut"
reference has the corresponding label. The "full", "collapsed", and "shortcut"
formats are all supported.
If there are reference definitions that are deliberately unreferenced, they can
be ignored by setting the `ignored_definitions` parameter. The default value of
this parameter ignores the following convention for adding non-HTML comments to
Markdown:
```md
[//]: # (This behaves like a comment)
```
<!-- markdownlint-configure-file {
"no-inline-html": {
"allowed_elements": [