项目

缩写扩展 (Markdig 规范文档)

本节描述了支持的不同扩展:

缩写

缩写可以通过使用 *[缩写标签]: 缩写描述 来声明。

缩写定义将从原始文档中移除。任何在字面量中找到的缩写标签将被替换为缩写描述:

*[HTML]: Hypertext Markup Language

Later in a text we are using HTML and it becomes an abbr tag HTML
.
<p>Later in a text we are using <abbr title="Hypertext Markup Language">HTML</abbr> and it becomes an abbr tag <abbr title="Hypertext Markup Language">HTML</abbr></p>

缩写定义可以最多缩进 3 个空格:

*[HTML]: Hypertext Markup Language
    *[This]: is not an abbreviation
.
<pre><code>*[This]: is not an abbreviation
</code></pre>

缩写可以包含空格:

*[SUPER HTML]: Super Hypertext Markup Language

This is a SUPER HTML document
.
<p>This is a <abbr title="Super Hypertext Markup Language">SUPER HTML</abbr> document</p>

缩写可以包含任何 Unicode 字符:

*[😃 HTML]: Hypertext Markup Language

This is a 😃 HTML document
.
<p>This is a <abbr title="Hypertext Markup Language">😃 HTML</abbr> document</p>

相似的缩写是允许的:

*[1A]: First
*[1A1]: Second
*[1A2]: Third

We can abbreviate 1A, 1A1 and 1A2!
.
<p>We can abbreviate <abbr title="First">1A</abbr>, <abbr title="Second">1A1</abbr> and <abbr title="Third">1A2</abbr>!</p>

缩写应匹配整个单词:

*[1A]: First

We should not abbreviate 1.1A or 11A!
.
<p>We should not abbreviate 1.1A or 11A!</p>

即使单词是整个内容,缩写也应匹配整个单词:

*[1A]: First

1.1A
.
<p>1.1A</p>

即使存在另一个术语表项,缩写也应匹配整个单词:

*[SCO]: First
*[SCOM]: Second

SCOM
.
<p><abbr title="Second">SCOM</abbr></p>

缩写应仅在周围有空白时匹配:

*[PR]: Pull Request

PRAA
.
<p>PRAA</p>

单字符缩写应该被匹配:

*[A]: Foo

A
.
<p><abbr title="Foo">A</abbr></p>

应使用最长匹配的缩写:

*[Foo]: foo
*[Foo Bar]: foobar

Foo B
.
<p><abbr title="foo">Foo</abbr> B</p>
在本文档中