Markdown语法

Posted soclear

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Markdown语法相关的知识,希望对你有一定的参考价值。




# 1.标题
使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。  
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
####### 最多六级标题,没有七级标题  


# 2.换行
Markdown的换行是使用两个以上空格加上回车。如果需要多个空行使用<br>,需要几个空行用几个<br>。


# 3.开始新的段落
在段落后面使用一个空行来表示重新开始一个段落。  
比如这是一个段落,只是换行了

而这是一个新的段落


# 4.字体
Markdown 可以使用以下几种字体:  
*斜体文本*  
_斜体文本_  
**粗体文本**  
__粗体文本__  
***粗斜体文本***  
___粗斜体文本___    
我个人比较喜欢用星号,因为打下划线要用到组合键,而星号在小键盘就有。


# 5.分割线
你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。
你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

***
* * *

*****

- - -

----------


# 6.删除线
如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线 ~~ 即可,实例如下:  
Markdown  
~~Markdown~~


# 7.下划线
下划线可以通过html的 <u>文本</u> 标签来实现:

<u>带下划线文本</u>

# 8.脚注
脚注是对文本的补充说明。某些软件可能不显示脚注。Markdown 脚注的格式如下:  
要注明的文本后紧跟一个空格[^脚注名字]  

以下实例演示了脚注的用法:  
要注明的文本 [^这是脚注的名字]。  
[^这是脚注的名字]:脚注的内容


# 9.有序列表、无序列表和列表嵌套。

## 9.1 无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,之后再加一个空格:

* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项


- 第一项
- 第二项
- 第三项
  
## 9.2 有序列表使用数字并加上 . 号再加上空格来表示,如:

1. 第一项
2. 第二项
3. 第三项

## 9.3 列表嵌套只需在子列表中的选项添加四个空格即可:

1. 第一项:
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项:
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素


# 10.区块
## 10.1 Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号:

> 区块引用  
> 菜鸟教程  
> 学的不仅是技术更是梦想

## 10.2 另外区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推:

> 最外层
> > 第一层嵌套
> > > 第二层嵌套
> > >
> > > > 第三层嵌套

## 10.3 区块中使用列表
区块中使用列表实例如下:

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

## 10.4 列表中使用区块
如果要在列表项目内放进区块,那么就需要在 > 前添加四个空格的缩进。

区块中使用列表实例如下:

* 第一项
    > 菜鸟教程  
    > 学的不仅是技术更是梦想
* 第二项


# 11.代码
## 11.1 如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:

`printf()` 函数

## 11.2 代码区块  
### 11.2.1 代码区块使用 4 个空格或者一个制表符(Tab 键)。

实例如下:  

    fun main(){
        println("Hello World!")
    }

### 11.2.2 你也可以用 ``` 包裹一段代码,并指定一种语言(也可以不指定):

$(document).ready(function () {
    alert(‘警告‘);
});
```

```kotlin
fun main(){
    println("Hello World!")
}
```


# 12.链接
## 12.1 链接使用方法一(含链接名称):

[链接名称](链接地址)

例如:[百度](https://www.baidu.com)

## 12.2 链接使用方法二(直接使用链接地址):
<链接地址>

例如:<https://www.baidu.com>

## 12.3 高级链接
链接也可以用变量来代替,文档末尾附带变量地址:  
这个链接用 1 作为网址变量 [Google][1]  
这个链接用 baidu 作为网址变量 [Baidu][baidu]  
然后在文档的结尾为变量赋值(网址)

[1]: http://www.google.com/
[baidu]: http://www.vaidu.com/


  # 13.图片
## 13.1 图片语法格式一:

![属性文本](图片地址)

![属性文本](图片地址 "可选标题")

例如:  
![百度logo](https://www.baidu.com/img/bd_logo1.png)

## 13.2 图片格式二:
也可以像网址那样对图片网址使用变量:

这个链接用 1 作为网址变量 [百度logo][1].
然后在文档的结尾为变量赋值(网址)

[1]: https://www.baidu.com/img/bd_logo1.png

## 13.3 Markdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的 <img> 标签。

<img src="https://www.baidu.com/img/bd_logo1.png" width="50%">


# 14.表格
Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。

## 14.1 语法格式如下:

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

## 14.2 对齐方式

我们可以设置表格的对齐方式:

-: 设置内容和标题栏居右对齐。
:- 设置内容和标题栏居左对齐。
:-: 设置内容和标题栏居中对齐。

实例如下:

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

# 15.高级技巧
## 15.1 支持的 HTML 元素
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。

目前支持的 HTML 元素有:  
<kbd>按键</kbd>  

<b>加粗</b>  

<i>斜体</i>  

<em>标签告诉浏览器把其中的文本表示为强调的内容。对于所有浏览器来说,这意味着要把这段文字用斜体来显示。 </em>  

<sup>标签定义上标文本。上标文本将会显示在当前文本流中字符高度的一半为基准线的上方,但是与当前文本流中文字的字体和字号都是一样的。上标文本能用来添加脚注。比如<sup>[1]<sup></sup> 

<sub>标签定义下标文本。下标文本将会显示在当前文本流中字符高度的一半为基准线的下方,但是与当前文本流中文字的字体和字号都是一样的。下标文本能用来表示化学公式,比如 H<sub>2</sub>O。</sup> 

回车<br>  

比如:  
使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

## 15.2 转义
Markdown使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown使用反斜杠转义特殊字符:

**文本加粗**  
** 正常显示星号 **

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

   反斜线  
`   反引号  
*   星号  
_   下划线  
{}  花括号  
[]  方括号  
()  小括号  
#   井字号  
+   加号  
-   减号  
.   英文句点  
!   感叹号  


## 15.3 公式
当你需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后,问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。如:

$log_2 x$  
${x^y}^z+x^{y^z}$
$sum^{j-1}_{k=0}{widehat{gamma}_{kj} z_k}$

$sum_{i=0}^n i^2 = frac{(n^2+n)(2n+1)}{6}$  

$f(x_1,x_x,ldots,x_n) = x_1^2 + x_2^2 + cdots + x_n^2 $  

$displaystyle lim_{t  o 0} int_t^1 f(t), dt$  

$lim_{t  o 0} int_t^1 f(t), dt$.


## 15.4 图
```flow
st=>start: 陪妹子进商场
op=>operation: 买买买
cond=>condition: 妹子开不开心?
e=>end: 出商场
st->op->cond
cond(yes)->e
cond(no)->op
```

```mermaid
graph LR
A[方形] -->B(圆角)
    B --> C{条件a}
    C -->|a=1| D[结果1]
    C -->|a=2| E[结果2]
    F[横向流程图]
```

```flow
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op
```

```flow
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op
```

```sequence
对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象A->对象B: 你真的好吗?
```

```sequence
Title: 标题:复杂使用
对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象B->小三: 你好吗
小三-->>对象A: 对象B找我了
对象A->对象B: 你真的好吗?
Note over 小三,对象B: 我们是朋友
participant C
Note right of C: 没人陪我玩
```

```mermaid
%% 时序图例子,-> 直线,-->虚线,->>实线箭头
  sequenceDiagram
    participant 张三
    participant 李四
    张三->王五: 王五你好吗?
    loop 健康检查
        王五->王五: 与疾病战斗
    end
    Note right of 王五: 合理 食物 <br/>看医生...
    李四-->>张三: 很好!
    王五->李四: 你怎么样?
    李四-->王五: 很好!
```

```mermaid
        gantt
        dateFormat  YYYY-MM-DD
        title 软件开发甘特图
        section 设计
        需求                      :done,    des1, 2014-01-06,2014-01-08
        原型                      :active,  des2, 2014-01-09, 3d
        UI设计                     :         des3, after des2, 5d
    未来任务                     :         des4, after des3, 5d
        section 开发
        学习准备理解需求                      :crit, done, 2014-01-06,24h
        设计框架                             :crit, done, after des2, 2d
        开发                                 :crit, active, 3d
        未来任务                              :crit, 5d
        耍                                   :2d
        section 测试
        功能测试                              :active, a1, after des3, 3d
        压力测试                               :after a1  , 20h
        测试报告                               : 48h
```

以上是关于Markdown语法的主要内容,如果未能解决你的问题,请参考以下文章

Markdown语法

Markdown 基本语法

MarkDown语法备忘

Markdown 简介及基础语法

Markdown语法

学习markdown语法