Markdown 语法
Contents
Markdown 语法
仅作提醒作用
| 元素 Elements | 语法 Syntax | 描述 Description |
|---|---|---|
| 块元素 Block Elements | ||
| 段落和换行符 PARAGRAPHS AND LINE BREAKS | 空行分隔创建段落换行 <br /> | 大部分情况下，Markdown会自动处理段落和换行，不需要手动插入<br />标签。只有在特定需要保留换行效果的情况下，才需要使用两个或更多空格加回车来插入换行标签。 |
| 标题 HEADERS | # H1### H3=== H1--- H2 | 支持两种样式的标题： Atx：在行的开头使用 1-6 个 # 符号，对应于标头级别 1-6；Setext：任意数量的下划线 =等号表示一级标题，任意数量的下划线-破折号表示二级标题。 |
| 块引用 BLOCKQUOTES | > This is an example of a blockquote. | 可以只把 > 放在段落的第一行之前；可以嵌套（即块引用中的块引用）通过添加额外的级别 > ；可以包含其他 Markdown 元素。 |
| 列表 LISTS | 有序（编号） ordered (numbered)1. First2. Second3. Third无序（项目符号） unordered (bulleted) * Red* Green* Blue | 用于标记列表的实际数字对 Markdown 生成的 HTML 输出没有影响； 为了使列表看起来漂亮，可以缩进段落（wrap items with hanging indents）； 列表项中的每个后续段落都必须缩进 4 个空格或一个制表符； 列表项中代码块需要缩进_两次_——8 个空格或两个制表符； 列表项中块引用的 > 分隔符需要缩进；一行开头的_数字-句点-空格 序列_ number-period-space sequence，可以反斜杠 backslash 转义 escape 句点 1986\. What a great season. ；无序列表使用星号 asterisks * 、加号 pluses + 和连字符 hyphens - （可互换）作为列表标记。 |
| 代码块 CODE BLOCKS | 将代码块的每一行缩进至少 4 个空格或 1 个制表符 | 代码块会继续，直到到达未缩进的行（或文章末尾）； 代码块中，与号 ( & ) 和尖括号 ( < 和 > ) 会自动转换为 HTML 实体；代码块内不处理常规 Markdown 语法。 |
| 横线 HORIZONTAL RULES | * * *********- - ----------- | 将三个或更多连字符 hyphens - 、星号 asterisks * 或下划线 underscores _ 单独放在一行上生成水平线标记 ( <hr /> )；可以在连字符或星号之间使用空格。 |
| —– | —– | —– |
| 跨度元素 Span Elements | ||
| 链接 LINKS | 内联 inline[example with an optional title](http://a.com/ "Title")[example](http://a.net/) has no title attribute | 引用 reference[an example][id] reference-style link使用空格来分隔括号组： [an example] [id]然后，在文档的任何地方，您都可以像这样定义链接标签，单独占一行： [id]: http://a.com/ "Optional Title Here"引用式链接的意义不在于它们更容易编写。关键是使用参考样式链接，您的文档源代码可读性大大提高。比较上面的例子：使用引用式链接，段落本身只有 81 个字符长；使用内联样式链接，它是 176 个字符；作为原始 HTML，它有 234 个字符。在原始 HTML 中，标记比文本多。 |
| 强调 EMPHASIS | 粗体 bold ：double * 或 _斜体 italic ： * 或 _*斜体*_斜体_**粗体**__粗体__ | 粗体（Bold）和斜体（Italic）用法的最佳实践 单词或短语的前后各添加三个星号或下划线 单词或短语的中间部分，请在要突出显示的部分前后各添加三个星号，中间不要带空格。 |
| 代码 CODE | 用反引号 backtick quotes ` 将其括起来。与预先格式化的代码块不同，代码跨度表示普通段落内的代码。例如：Use the `printf()` function. | 在代码范围内包含文字反引号字符，您可以使用多个反引号作为开始和结束分隔符： ``There is a literal backtick (`) here.``代码范围周围的反引号分隔符需要包含空格： A single backtick in a code span: `` ` ``A backtick-delimited string in a code span: `` `foo` `` |
| 图片 IMAGES | 内联 感叹号 exclamation mark ! 开头 ： | 引用：![Alt text][id]其中“id”是定义的图像引用的名称。图像引用使用与链接引用相同的语法定义： [id]: url/to/image "Optional title attribute"Markdown 没有指定图像尺寸的语法，需要的话请使用常规 HTML <img> 标记。 |
| —– | —– | —– |
| 其他元素 MISCELLANEOUS | ||
| 自动链接 AUTOMATIC LINKS | 尖括号 angle brackets 将 URL 或电子邮件地址括起来：<http://example.com/> | 显示一个 URL 或电子邮件地址的实际文本，并且让它成为一个可点击的链接，支持为 URL 和电子邮件地址创建“自动”链接的快捷方式 |
| 反斜杠转义 BACKSLASH ESCAPES | 使用反斜杠转义来生成文字字符：\*literal asterisks\* | 以下字符提供反斜杠转义：\ backslash` backtick* asterisk_ underscore{} curly braces[] square brackets() parentheses# hash mark+ plus sign- minus sign (hyphen). dot! exclamation mark |