markdown 常用语法

Posted xzdm

tags:

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

一、标题

标题只有 6 级,分别对应 html 标签的 h1 - h6,推荐写法:

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

其他写法: #一级标题#、##二级标题##

二、列表

有序列表

有序列表的序号由第一个数字决定


2. 列表 1

3. 列表 2

4. 列表 3

  1. 列表 1
  2. 列表 2
  3. 列表 3

无序列表

无序列表可以用* 、+ 、- 来创建,推荐使用 ‘-‘


- 列表 1

- 列表 2

- 列表 3

  • 列表 1
  • 列表 2
  • 列表 3

三、区块引用

用于对某部分内容作一些说明,使用方式:

> 一级引用

> > 二级引用

> > > 三级引用

> > > > 四级引用

> > > > > 五级引用

> > > > > > 六级引用

> > > > > > > 七级引用

一级引用

二级引用

三级引用

四级引用

五级引用

六级引用

七级引用


理论上引用级别可以无限拓展

四、分割线

分割线可以由* - _(星号,减号,底线)这 3 个符号的至少 3 个符号表示,注意至少要 3 个,且不需要连续,有空格也可以,推荐使用连续三个减号

---


五、链接

链接书写方式有两种:行内式和参数式,不管是哪一种,链接文字都是用 [方括号] 来标记:

行内式

查阅[Vue.js 风格指南](https://cn.vuejs.org/v2/style-guide/index.html)

查阅[eslint-插件,VUE](https://eslint.vuejs.org/rules/)

查阅Vue.js 风格指南

查阅eslint-插件,VUE

参数式

格式[参数]: 地址 title,参数放到中括号中,英文冒号+空格:

[Vue.js 风格指南]: https://cn.vuejs.org/v2/style-guide/index.html "风格指南"

[eslint-插件,VUE]: https://eslint.vuejs.org/rules/ "eslint-插件,VUE"

查阅[Vue.js 风格指南],查阅[eslint-插件,VUE]

查阅Vue.js 风格指南,查阅eslint-插件,VUE

六、图片

格式与链接一致,只是在中括号之前增加了英文叹号!

行内式

行内式的图片显示:![Vue Logo](https://cn.vuejs.org/images/icons/favicon-32x32.png)

行内式的图片显示:技术图片

参数式

[Vue Logo]: https://cn.vuejs.org/images/icons/favicon-32x32.png

参数式的图片显示:![Vue Logo] 参数式的图片显示:技术图片

七、代码框

用户展示一部分代码片段,两种展示方式:

拼接字符串的方式``:

import selectTemplate from ‘@/components/choiceModule/index.vue‘ // 选择模板

多行使用```code```进行包裹,可以在首行写注释:

selectTmpl(type) 
  this.moduleTypeFlag = type

八、表格

只推荐如下写法

| Tables        | Are           | cool             |
| ------------- | ------------- | ---------------- |
| col           | right-aligned | vertical-align   |
| row           | centered      | background-color |
| zebra stripes | are neat      | middle           |
TablesArecool
col right-aligned vertical-align
row centered background-color
zebra stripes are neat middle

九、强调

强调分为两种:加粗、倾斜

加粗<strong>

**加粗字体**加粗字体

__加粗字体__加粗字体

倾斜<em>

*倾斜字体*倾斜字体

_倾斜字体_倾斜字体

十、转义

符号的转义类似 js 语法加反斜线即可

`

!

#

*

(

)

-

_

+

.

\

[

]

十一、删除线

双波浪包裹

~~带有删除线的文本~~

带有删除线的文本

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

Typora+markdown 最常用语法教程

JIRA常用markdown语法整理

Markdown常用语法详解

Markdown常用语法详解

Markdown常用语法详解

超用心整理Markdown常用语法介绍,看这一个就够了