最全 Markdown是Github最常见的文档说明。Markdown的语法简洁明了、学习容易。按照官方Markdown Cheat Sheet逐个操作一遍自然就会了。 [TOC]这个语法在markdown工具里能够识别。..

一、最全的Markdown语法

Markdown是Github最常见的文档说明。Markdown的语法简洁明了、学习容易。按照官方Markdown Cheat Sheet逐个操作一遍自然就会了。
Test

[TOC]这个语法在markdown工具里能够识别，但是在这里不能识别。

1.1 目录

代码：

1
2
3
  [TOC]
[MENU]

效果显示如上

1.2 多级标题

代码：

一级标题

二级标题

多级标题
1
2
3
4
5
6
7
8
9
10
11
12
  
 
  效果 ### 一级标题 #### 二级标题 多级标题  
 
#### 1.3 引用与注释
 
代码：

```markdown
> 一级引用
>> 二级引用
>>>>> n级引用

效果

1.4 插入代码

行内代码

代码：

行内代码

效果：

1
行内代码
代码段

这是代码：

1
//代码中无视markdown语法，所以本文中所有展示markdown原始文本的部分都是用代码段包起来的。

代码：

1
2
var s = "JavaScript syntax highlighting";
alert(s);
1
2
s = "Python syntax highlighting"
print s
1
markdown

1.5 多级列表

无序列表

代码：

1
2
3
4
5
6
//-*+三个符号在无序列表中地位平等
- 第一项
* 第二项
    * 第二项//前面加一个空格或tab就表示下一级
        * 这又是一级
+ 第三项

效果：

  • 第一项
  • 第二项
    • 第二项//前面加一个空格或tab就表示下一级
      • 这又是一级
  • 第三项
有序列表

代码：

1
2
3
//数字加.加空格表示一个有序列表项，tab或空格触发下一级
1. 这是有序的
2. 这是有序的

效果：

  1. 这是有序的

  2. 这是有序的

    这是有序的

1.6 超链接

行内超链接

代码： [百度](baidu.com) 效果

百度

参数式超链接

代码：

声明：[百度]:baidu.com
使用：进入[百度]

1
2
3
4
5
6
  
#### 1.7 字体
 
 代码：

斜体
粗体
斜体加粗

1
2
3
~~删除线~~


效果

斜体 粗体 斜体加粗 删除线

1.8 表格

代码：

TablesAreCool
col 3 isright-aligned$1600
col 2 iscentered$12
zebra stripesare neat$1

注释：
—–: 表示右对齐
:—– 表示左对齐
:—-: 表示居中对齐

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
  
 
 效果 
 
 
   Tables 

   Are 

   Cool 
   
  
   col 3 is 

   right-aligned 
   $1600 
   
   
   col 2 is 

   centered 
   $12 
   
   
   zebra stripes 

   are neat 
   $1 
   
  
#### 1.9 图片
 
 代码： 
 
 
  ![图片](图片地址)

//注意，默认图片格式是原始尺寸，如果想自定义图像大小，要用img标签：

1
2
3
4
5
6
7
8
9

Inline-style: 
![alt text](https://api.opics.org/api "Logo Title Text 1")

Reference-style: 
![alt text][logo]

[logo]: https://api.opics.org/api "Logo Title Text 2"

Inline-style: Test
Reference-style: Test

设置图片大小
Markdown自带功能

代码：

loading.png

loading.png

1
2
3
4
 

效果显示

使用HTML 标签并设置width和height和比例放缩
1
2
3
4
5
6
7
8
9
10
 
 代码： 
 
 
 ```xml
<img src="https://api.opics.org/api" alt="图片替换文本" width="500" height="313" align="bottom" />

<img src="https://api.opics.org/api" alt="图片替换文本" width=60% />

效果显示

1
<img src="https://api.opics.org/api" alt="图片替换文本" width=25% />

1.10 多选框

代码：

1
2
3
4
  - [x] A
- [ ] B
- [x] 已选中
- [ ] 未选中
1
2
3
4
5
- [ ] 支持以 PDF 格式导出文稿
- [ ] 改进 Cmd 渲染算法，使用局部渲染技术提高渲染效率
- [x] 新增 Todo 列表功能
- [x] 修复 LaTex 公式渲染问题
- [x] 新增 LaTex 公式编号功能
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
  
 
  效果显示  
  [x] A  
  [ ] B  
  [x] 已选中  
  [ ] 未选中  
  [ ] 支持以 PDF 格式导出文稿  
  [ ] 改进 Cmd 渲染算法，使用局部渲染技术提高渲染效率  
  [x] 新增 Todo 列表功能  
  [x] 修复 LaTex 公式渲染问题  
  [x] 新增 LaTex 公式编号功能  
 
#### 1.11 脚注 (footnote)
 
 代码： 
 
 
  文章正文某处[^脚注id]文章正文
[^脚注id]: 脚注内容


效果显示

文章正文某处^脚注id文章正文

1.12 流程图

代码：

​flow

1
2
3
4
5
6
7
8
st=>start: Start :>https://amwiki.xf09.net[blank]
e=>end: End :>https://amwiki.xf09.net[blank]
op1=>operation: My Operation
op2=>operation: Stuff
sub1=>subroutine: My Subroutine
cond=>condition: Yes or No? :>https://amwiki.xf09.net[blank]
c2=>condition: Good idea
io=>inputoutput: catch something...
1
2
3
4
5
st->op1(right)->cond
cond(yes, right)->c2
cond(no)->sub1(left)->op1
c2(yes)->io->e
c2(no)->op2->e

​```

效果显示

流程图语法介绍

流程图语法分两个部分，一个是声明元素，一个是定义流程

声明元素
1
2
语法： `tag=>type: content :>url` `tag` 
  设置元素名称 `=>` 元素定义符

type
: 设置元素类型，共分6种：

start：开始，圆角矩形
end：结束，圆角矩形
operation：操作/行动方案，普通矩形
subroutine：子主题/模块，双边线矩形
condition：条件判断/问题审核，菱形
inputoutput：输入输出，平行四边形

content

1
设置元素显示内容，中英均可 `:>url` 设置元素连接，可选，后接 [blank] 可以新建窗口打开  
1
提示：注意空格， `=>` 前后都不能接空格；

type:

1
后必须接空格； `:>` 是语法标记，中间不能有空格
定义流程
1
语法： `tag1(branch,direction)->tag2` ```java

->

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
  流程定义符，连接两个元素 
  
 `branch` 
  设置  
 `condition` 
  类型元素的两个分支，有 yes/no 两个值，其他元素无效 
  
 `direction` 
  定义流程走线方向，有 left/right/top/bottom 四个值，所有元素有效，此项配置可选 （PS: 此属性目前有一定几率触发图形错位，刷新即可） 
 
小提示： 
 
  继续注意空格， `->` 前后都不能有空格  
  由于  
  类型有两个分支，我们一般遇到  
  元素就换行书写，比如：  
    st->op1-c2


由于OSCHINA社区Markdow支持功能有限，有些命令无法在这里显示。我用的是typora编辑markdown文档，这个markdown工具是免费的。 这里附上我的README.md和生成后的pdf文档how_to_use_markdown.pdf。

本文标题： 最全的Markdown语法

发布时间： 2019年03月21日 00:00

最后更新： 2025年12月30日 08:54

原始链接： https://haoxiang.eu.org/380226b/

版权声明： 本文著作权归作者所有，均采用CC BY-NC-SA 4.0许可协议，转载请注明出处！

赏
× 喜欢就赞赏一下呗！
打赏二维码