Add new MD054/link-image-style rule (in-progress PR, no generated files).

This commit is contained in:
Tommy G 2023-10-24 21:07:46 -07:00 committed by David Anson
parent 20b8af5054
commit 460836445c
14 changed files with 296 additions and 11 deletions

View file

@ -1,7 +1,7 @@
Links and images in Markdown can provide the link destination or image source
at the time of use or can define it elsewhere and use a label for reference.
The reference format is convenient for keeping paragraph text clutter-free
and makes it easy to reuse the same URL in multiple places.
at the time of use or can use a label to reference a definition elsewhere in
the document. The latter reference format is convenient for keeping paragraph
text clutter-free and makes it easy to reuse the same URL in multiple places.
Because link and image reference definitions are located separately from
where they are used, there are two scenarios where a definition can be

11
doc-build/md054.md Normal file
View file

@ -0,0 +1,11 @@
Links and images in Markdown can provide the link destination or image source
at the time of use or can use a label to reference a definition elsewhere in
the document. The latter reference format is convenient for keeping paragraph
text clutter-free and makes it easy to reuse the same URL in multiple places.
This rule can be used to enforce a link or image style for the document that:
- `inline`: provides the link destination or image source at the time of use
- `reference`: defines the link destination or image source elsewhere to be
referenced by label
- or `consistent`: Requires the same style be used everywhere in the document