Markdown
MarkdownLint 错误
Md052

MD052- 参考链接和图像应使用定义的标签

标签:imageslinks

别名:reference-links-images

参数:

  • shortcut_syntax:包括快捷语法(boolean默认false

Markdown 中的链接和图像可以在使用时提供链接目的地或图像源,也可以在其他地方定义它并使用标签作为参考。参考格式可以方便地保持段落文本的整洁,并且可以轻松地在多个地方重复使用相同的 URL。

参考链接和图像分为三种:

Full: [text][label]
Collapsed: [label][]
Shortcut: [label]
 
Full: ![text][image]
Collapsed: ![image][]
Shortcut: ![image]
 
[label]: https://example.com/label
[image]: https://example.com/image

当定义了相应的标签时,链接或图像会正确呈现,但当标签不存在时,会显示为带括号的文本。默认情况下,此规则会警告“完整”和“折叠”引用语法的未定义标签,但不会警告“快捷方式”语法,因为它不明确。

该文本[example]可以是快捷方式链接或括号中的文本“示例”,因此默认情况下会忽略“快捷方式”语法。要包含“快捷方式”语法,请将include_shortcut参数设置为true。请注意,这样做会对文档中可能是快捷方式的所有文本产生警告。如果括号内的文本是故意的,括号可以用字符转义:。\\[example\]