markdown syntax.

Markdown 语法和实例

GitHub Flavored Markdown (GFM)

主要应用于GitHub的Markdown扩展——

标题（Headers）

Markdown中共有6级标题，从 #、##、依次类推到 ######。

1. 实例代码

# 一级标题
## 二级级标题
### 三级标题
#### 四级级标题
##### 五级标题
###### 六级标题

2. 呈现效果

一级标题

二级级标题

三级标题

四级级标题

五级标题
六级标题

字体（Emphasis）

  • 斜体：用 * 或者 _ 包裹文本进行 斜体 格式化。
  • 粗体：用 ** 或者 __ 包裹文本进行 粗体 格式化。
  • 删除线：用~~包裹文本进行删除线格式化，部分工具和网站不支持展示。

** 或者 __、* 或者 _，以及~~ 可以 组合使用。

1. 实例代码

*这行文本是斜体*

_这行文本是斜体_

**这行文本是粗体**

__这行文本是粗体__

_这行文本是 **粗体** + 斜体_

~~_这行文本是 **粗体** + 斜体_ + 删除线~~

2. 呈现效果

这行文本是斜体

这行文本是斜体

这行文本是粗体

这行文本是粗体

这行文本是 粗体 + 斜体

这行文本是 粗体 + 斜体 + 删除线

变量（Variables）

Markdown 中支持变量定义和变量引用，且支持中文。

  • 变量定义：[key]: value
  • 变量引用：[key]、[text][key]

1. 实例代码

定义链接：[Markdown指南]: https://markdown.budshome.com

引用链接：

key引用：[Markdown指南]

value引用：[未定义文本][Markdown指南]

2. 呈现效果

引用链接：

key引用：Markdown指南

value引用：未定义文本

图像（Images）

格式：![Alt Text](url)

1. 实例代码

![Demo Image](./imgs/demo-image.png)

2. 呈现效果

Demo Image

链接（Links）

Markdown中可对url链接自动识别，但有些Markdown工具不支持（GitHub支持自动识别）。

若需指定url链接文本，格式：[文本](url)。

1. 实例代码

[Markdown指南](https://markdown.budshome.com)

https://markdown.budshome.com

markdown.budshome.com

2. 呈现效果

锚点（Anchors）

格式：[锚点文本](#锚点链接)。需要注意如下几点：

  • 欲定位的锚点链接必须是标题，即#、###等定义的6级标题；
  • 不管标题大小写，锚点均为小写；
  • 可以使用中文做锚点，中文锚点需要省略（、、等中文标点符号。

1. 实例代码

标题：## 锚点（Anchors）
锚点：[锚点（Anchors）](#锚点anchors)

2. 呈现效果

引用（Blockquotes）

Markdown中通过>实现引用。引用可以多级嵌套：>>,>>>；也可以和其它Markdown语法嵌套，比如无序列表。

1. 实例代码

> 一级文本引用
>> 二级文本引用

引用中嵌套无序列表

>> * 这是第一项
>> * 这是第二项

2. 呈现效果

不同工具和输出呈现效果有差别，如下两种——

Markdown预览呈现

blockquotes

输出HTML呈现

一级文本引用

二级文本引用

引用中嵌套无序列表

  • 这是第一项
  • 这是第二项

代码（Code）

Markdown中代码格式化可以通过三种方式：

  • 行内式：通过一对 ` 包裹单行代码实现；
  • 代码块：通过一对 ``` 包裹实现，可以指定代码的编程语言，如Python、JavaScript、Rust等，且支持语法高亮；
  • 缩进式：通过缩进 >= 4空格实现，部分支持语法高亮。

1. 实例代码

行内式代码：`import os, sys`

代码块（无需缩进）：
    ``` Python
    import os, sys

    sys.path

    print(os)

缩进式：
if (isAwesome){
return true
}


### 2. 呈现效果

<div style="border:1px solid;margin:0px;padding:0px 0px 0px 15px">

行内式代码：`import os, sys`

代码块（无需缩进）：

``` Python
import os, sys

sys.path

print(os)

缩进式：

if (isAwesome){
    return true
}