MarkDown基本语法使用教程

文章目录

  • 1.标题
  • 2.字体样式
  • 3.引用
  • 4.分割线
  • 5.插入图片
  • 6.超链接
  • 7.列表
  • 8.表格
  • 9.代码
  • 10.转义
  • 11.支持HTML
  • 12.流程图、甘特图、UML图
  • 13.数学公式
  • 14.目录
  • 15.注解
  • 16.脚注




Markdwon 是一种轻量级 标记语言,它以纯文本形式(易读、易写、易更改)编写文档,并最终以HTLM格式发布。Markdown也可以理解为将以 MARKDOWN语法编写的语言转换成HTML内容的工具

1.标题

在想要设置为标题的文字前面加#来表示,markdown最多支持六级标题

md语法

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

效果
MarkDown基本语法使用教程_第1张图片


2.字体样式

加粗的文字左右分别用两个*号或_包起来
要倾斜的文字左右分别用一个*号或_包包起来
要倾斜和加粗的文字左右分别用三个*号或_包包起来
要加删除线的文字左右分别用两个~~号包起来

md语法

斜体
*斜体内容*
_斜体内容_
加粗
**加粗内容**
__加粗内容__
斜体+加粗
***斜体加粗内容***
___斜体加粗内容___
删除线
~~删除线内容~~

效果
斜体
斜体内容
斜体内容
加粗
加粗内容
加粗内容
斜体+加粗
斜体加粗内容
斜体加粗内容
删除线
删除线内容


3.引用

在引用的文字前加>,引用也可以嵌套,markdown支持无限级的引用,一般只用一级引用
md语法

> 引用一
>> 引用二
>>> 引用三

效果

引用一

引用二

引用三


4.分割线

分割线使用三个或三个以上的 - 或 * 进行分割
md语法

---
----
***
****

效果





5.插入图片

md语法

![alt内容](图片url ''图片标题'')

alt内容:显示在图片下面的文字,相当于对图片内容的解释,有些md编辑器不支持。
图片URL:图片的地址,可以使本地地址,也可以是网络图片的地址
图片标题:当鼠标移到图片上时显示的内容。标题可加可不加

示例

![提示内容](https://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cuYmFpZHUuY29tL2ltZy9iZF9sb2dvMS5wbmc "图片标题")

效果
MarkDown基本语法使用教程_第2张图片


6.超链接

md语法

[超链接名称](超链接地址 "超链接标题")
或
<超链接地址>

超链接名称:显示出来的文字。
超链接地址:需要跳转的超链接地址
超链接标题:当鼠标移到超链接上时显示的内容。标题可加可不加

示例

[超链接名称](http://baidu.com "超链接标题")

效果
超链接名称
http://baidu.com


7.列表

  • 有序列表
    数字加点,序号跟内容之间要有空格。有序列表和无序列表都可以嵌套使用。
    md语法
1. 有序列表
2. 有序列表
3. 有序列表

效果

  1. 有序列表
  2. 有序列表
  3. 有序列表
  • 无序列表
    用 - + * 任何一种都可以,- + * 跟内容之间都要有一个空格
    md语法
+ 无序列表
- 无序列表
* 无序列表

效果

  • 无序列表
  • 无序列表
  • 无序列表
  • 任务列表
    md语法
- [ ] 计划任务1
- [ ] 计划任务2
- [x] 完成任务3
- [x] 完成任务4

效果

  • 计划任务1
  • 计划任务2
  • 完成任务3
  • 完成任务4

8.表格

md语法

表头|表头|表头
:--|--:|:--:
左对齐|居右对齐|中间对齐
内容|内容|内容

第一行是表格的标题,决定表格的列数,表头与表头用 | 隔开
第二行用来分割表头和内容,表格内容左对齐,则在"--"前加“:”,
	如果需要右对齐,则在"--"后加“:”,居中则在“--”两边都加“:”

效果

表头 表头 表头
左对齐 居右对齐 中间对齐
内容 内容 内容

9.代码

md语法

单行代码:
`代码内容`

多行代码:
(```) 去掉括号
	代码区
(```) 去掉括号

效果
单行代码:
代码内容

多行代码:

	代
	码
	区

10.转义

和其他编程语言类似,Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符"\"。
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
md语法

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

示例

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

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


11.支持HTML

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有:
等。
md语法

Ctrl    表示按键Ctrl
内容    内容加粗
内容    内容倾斜
内容    内容强调
ABC内容   内容上标
ABC内容   内容下标

效果
Ctrl 表示按键Ctrl
内容 内容加粗
内容 内容倾斜
内容 内容强调
ABC内容 内容上标
ABC内容 内容下标


12.流程图、甘特图、UML图

MarkDown支持多种例如流程图、甘特图、UML图的绘制,图设计内容比较多,会在另外的文章里面详细说明。
MarkDown流程图可以使用mermaid流程图,也可以使用flow流程图。
这里只给出两种流程图的简单使用示例。

1.使用mermaid制作流程图

md语法

```mermaid
	graph TB
	start(开始) -->  in[输入分数Score]
	in --> judg{Score > 100}
	judg --否-->err[分数不合法]
	judg --是-->judg80{Score >= 80}
	judg80 --是-->out80[优秀]
	judg80 --否--> judg60{Score >= 60}
	judg60 --是--> out60[中等]
	judg60 --否-->out0[差]
	out80 --> out[输出等级]
	out60 --> out[输出等级]
	out0 --> out[输出等级]
	out --> stop(结束)
	err -->stop
$```(使用时去掉$)

效果

开始
输入分数Score
Score > 100
分数不合法
Score >= 80
优秀
Score >= 60
中等
输出等级
结束

2.使用flow制作流程图
md语法

注意:1.“:”后需要有一个空格   2.“=>”和"->"前后都不能有空格
```$flow
st=>start: 开始
in=>operation: 输入分数Score
judg=>condition: Score > 100
err=>operation: 分数不合法
judg80=>condition: Score >= 80
out80=>operation: 优秀
judg60=>condition: Score >= 60
out60=>operation: 中等
out0=>operation: 差
out=>operation: 输出等级
ed=>end: 结束

st->in->judg
judg(yes)->judg80
judg(no)->err->ed
judg80(yes)->out80->out
judg80(no)->judg60->out
judg60(yes)->out60->out
judg60(no)->out0->out
out->ed
	
$```(使用时去掉所有$)

效果

Created with Raphaël 2.2.0 开始 输入分数Score Score > 100 Score >= 80 优秀 输出等级 结束 Score >= 60 中等 差 分数不合法 yes no yes no yes no

在某些markdown编译其中,会将flow流程图转换成mermaid流程图,上面的流程图转换成mermaid的流程图代码如下:

```mermaid
flowchat
st=>start: 开始
in=>operation: 输入分数Score
judg=>condition: Score > 100
err=>operation: 分数不合法
judg80=>condition: Score >= 80
out80=>operation: 优秀
judg60=>condition: Score >= 60
out60=>operation: 中等
out0=>operation: 差
out=>operation: 输出等级
ed=>end: 结束

st->in->judg
judg(yes)->judg80
judg(no)->err->ed
judg80(yes)->out80->out
judg80(no)->judg60->out
judg60(yes)->out60->out
judg60(no)->out0->out
out->ed
$```(使用时去掉$)

13.数学公式

当需要在编辑器中插入数学公式时,可以使用一个或两个美元符 $ 包裹 TeX 或 LaTeX 格式的数学公式来实现。
此处涉及的LaTex公式会通过另外一篇文章讲解,在这里用一个示例简单试用一下。
md语法

范德蒙行列式:

$$|A|  = \left[\begin{matrix} 1&1&\cdots&1 \\  
a_1&a_2&\cdots&a_n \\  
\vdots&\vdots&\vdots&\vdots \\  
a_1^{n-1}&a_2^{n-1}&\cdots&a_n^{n-1} \\
\end{matrix}\right] = \displaystyle \prod^{}_{j>i}(a_j-a_i)$$

效果
∣ A ∣ = [ 1 1 ⋯ 1 a 1 a 2 ⋯ a n ⋮ ⋮ ⋮ ⋮ a 1 n − 1 a 2 n − 1 ⋯ a n n − 1 ] = ∏ j > i ( a j − a i ) |A| = \left[\begin{matrix} 1&1&\cdots&1 \\ a_1&a_2&\cdots&a_n \\ \vdots&\vdots&\vdots&\vdots \\ a_1^{n-1}&a_2^{n-1}&\cdots&a_n^{n-1} \\ \end{matrix}\right] = \displaystyle \prod^{}_{j>i}(a_j-a_i) A=1a1a1n11a2a2n11anann1=j>i(ajai)


14.目录

md语法

@[TOC](目录标题)

效果
见页首


15.注解

注解通常用来批量解释一些专业术语,专业短语等知识,使用注解后,将鼠标放到需要解释的术语上,就可以看到我们的解释内容。
需要注意的是,在内容中注释的短语前后需要使用空格隔开。
md语法

自1990年以来,HTML就一直被用作WWW的信息表示语言,使用HTML语言描述的文件需要通过WWW浏览器显示出效果。
HTML是一种建立网页文件的语言,通过标记式的指令(Tag),将影像、声音、图片、文字动画、影视等内容显示出来。
事实上,每一个HTML文档都是一种静态的网页文件,这个文件里面包含了HTML指令代码。

*[HTML]: 超文本标记语言
*[WWW]: 万维网

效果
自1990年以来,HTML 就一直被用作 WWW 的信息表示语言,使用 HTML 语言描述的文件需要通过 WWW 浏览器显示出效果。
HTML 是一种建立网页文件的语言,通过标记式的指令(Tag),将影像、声音、图片、文字动画、影视等内容显示出来。
事实上,每一个 HTML 文档都是一种静态的网页文件,这个文件里面包含了 HTML 指令代码。

16.脚注

为了增加文档的可读性,时常会在文档中添加一些脚注,脚注位于页面的底部,可以作为文档某处内容的注释。当我们使用鼠标点击注脚编号时,页面会自动跳转自相应的脚注处。
md语法

超文本标记语言[^1]是标准通用标记语言下的一个应用[^2],也是一种规范,一种标准

[^1]: 超文本标记语言,英文为HTML,由Tim Berners-Lee发明
[^2]: 现代人常说的应用,一般指手机和平板电脑的应用。在面向对象上通常分为个人用户应用与企业级应用

效果
超文本标记语言1是标准通用标记语言下的一个应用2,也是一种规范,一种标准


  1. 超文本标记语言,英文为HTML,由Tim Berners-Lee发明 ↩︎

  2. 现代人常说的应用,一般指手机和平板电脑的应用。在面向对象上通常分为个人用户应用与企业级应用 ↩︎

你可能感兴趣的:(其它)