Markdown基础语法

1. 简述

Markdown是一种易读易写的纯文本标记语言,能够实现使用少量标记符号以最小的输入代价生成极富表现力的文档,也可以快速制作Todo列表、书写LaTex公式、高亮代码,也可以高效绘制流程图、甘特图和数据表格等,实现了流畅书写与印刷级阅读之间的一种平衡。

2. 段落和换行

语法说明:
一个Markdown段落是由一个或多个连续的文本组成,其前后又一个以上的空行

3. 分级标题

语法说明(类Atx形式):
在行首加井号(#)表示不同级别的标题 (H1-H6),例如:# H1, ## H2, ### H3,#### H4,……

代码示例:
# 一级标题
##二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

4. 斜体和粗体

语法说明:
使用 * 和 ** 表示斜体和粗体

代码示例:
*斜体*
**粗体**

5. 链接

语法说明:
使用 [描述](链接地址)为文字增加外链接,可以分为行内式和参考式两种

  • 行内式的链接:只要在方括号后面紧接着圆括号并插入网址链接或本地相对路径即可,链接之后还可以加上title文字,用双引号把title文字包起来即可
  • 参考式的链接:在链接的文字后面再接上另一个方括号,在第二个方括号内填入用以识别链接的标记,接着可以在文档的任意处,把这个链接内容定义出来
    参考式进一步简化书写,省去第二个方括号中的id,直接用第一个方括号中的an example代替标记,即为隐式链接

代码示例:
[Yandex](https://www.yandex.com)
行内式:
This is [an example](http://example.com/ "Title") inline link
[This link](http://example.net/) has no title attribute
参考式:
This is [an example][id] reference-style link
[id]: http://example.com/ "Optional Title Here"

自动链接:用方括号将网址链接或邮箱地址包起来即可

代码示例:

6. 列表

语法说明:
列表分为无序列表和有序列表,在行首使用*,+,-表示无序列表,使用数字和点表示有序列表

代码示例:
* 无序列表
+ 无序列表
- 无序列表
1\. 有序列表

7. 引用

语法说明:

使用>表示引用,在每一行最前面加上>或只在整个段落的第一行最前面加上>

代码示例:
> 引用文本行

嵌套引用:
根据层次加上不同数量> ,也可以在引用中使用其他Markdown语法,包括标题、列表、代码区块等

8. 行内代码

语法说明:
使用 `代码` 表示行内代码块

代码示例:
`hello world`

9. 插入图片

语法说明:
使用![描述](图片链接地址)插入图像

10. 内容目录

语法说明:
在段落中填写[TOC] 以显示全文内容的目录结构

代码示例:
[TOC]

11. 删除线

语法说明:
使用 ~~表示删除线,注意使用英文字符

代码示例:
~~删除此文本行~~

12. 分隔线

语法说明:
在一行中使用三个或以上的星号、减号或底线来建立一个分隔线,星号或减号之间可以插入空格

代码示例:
***
* * *

13. 引注

语法说明:
使用 [^keyword]表示引注

14. LaTex公式

语法说明:
$表示行内公式,$$表示整行公式

代码示例:
$E=mc^2$

参考资料https://math.meta.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference

15. 代码块

语法说明:
```开启代码语言类型选择

16. 流程图

语法说明:
```flow 开启流程图输入

参考资料:https://mermaidjs.github.io/flowchart.html

17. 甘特图

语法说明:
```gantt 开启甘特图输入

参考资料:https://mermaidjs.github.io/gantt.html

18. 表格

语法说明:
|表示单元格分割,---表示左对齐,---:表示右对齐,:---:表示居中对齐

19.To-do列表

语法说明:
使用带有[ ][x](未完成或已完成)项的列表语法撰写一个待办事宜列表,并且支持子列表嵌套以及混用Markdown语法

代码示例:
- [ ]待完成事项
- [x] 已完成事项

20. 插入普通符号

语法说明:
在以下符号前添加反斜杠\来插入符号

\\反斜线
\‘反引号
\* 星号
\_ 底线
\{ \}大括号
\[ \]方括号
\( \)括号
\# 井字号
\+ 加号
\-减号
\. 英文句号,小数点
\! 惊叹号

参考资料

[1] 作业部落 Cmd Markdown高阶语法手册

[2] 百度百科 markdown

[3] Markdown 语法说明 (简体中文版)

[4] Markdown: Syntax

[5] Markdown editing with Visual Studio Code

你可能感兴趣的:(Markdown基础语法)