Markdown语法手册(标准版)

Posted by WangW on December 9, 2018

1. 斜体和粗体

1
2
3
4
*斜体*或者_斜体_
**粗体**
***加粗斜体***
~~删除线~~

斜体 或者 斜体

粗体

加粗斜体

删除线


2. 分级标题

1
2
3
4
5
6
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

3. 超链接

Markdown 支持两种形式的链接语法:行内式和参考式两种形式, 行内式一般使用较多。

3.1. 行内式

语法说明:[]()

[]里写链接文字,()里写链接地址,()中的“ ”中可以为链接指定title属性,title属性可加可不加。title属性的效果是鼠标悬停在链接上会出现指定的title文字。链接地址与链接标题前有一个空格。

1
2
欢迎来到[WangW Blog](https://likewind.top)
欢迎来到[WangW Blog](https://likewind.top "WangW Blog")

欢迎来到WangW Blog

欢迎来到WangW Blog

3.2. 参考式

参考式超链接一般用在学术论文中,或者当一个链接在文章中多次使用时,那么使用引用的方式创建链接非常好,它可以让你对链接进行统一的管理。

语法说明:[name][1]

第一个[]写链接文章,第二个[]写标记。

1
2
3
4
5
我经常去的几个网站[Google][1], [WangW Blog][2], [WangW Blog][].

[1]:http://www.google.com
[2]:https://likewind.top "WangW Blog"
[WangW Blog]:https://likewind.top

我经常去的几个网站Google, WangW Blog, WangW Blog.

3.3. 自动链接

1
2
<http://example.com>
<address@example.com>

http://example.com address@example.com


4. 锚点

网页中,锚点就是业内的超链接,也就是链接本文档内部的某些元素,实现当前页面中的挑转。

1
[跳转到3](#3-超链接)

跳转到3

注意:

  1. ()内要取掉点,比如3. 超链接,要取掉英文句号
  2. ()内要将空格变成-号
  3. ()内要将大写变成小写,比如3. 超链接,要变成3-超链接

5. 列表

5.1. 无序列表

使用*, +, - 表示无序列表

1
2
- 无序列表 
- 无序列表 
  • 无序列表 一
  • 无序列表 二

5.2. 有序列表

有序列表使用数字加一个英文句号。

1
2
1. 有序列表 
2. 有序列表 
  1. 有序列表 一
  2. 有序列表 二

5.3. 定义型列表

语法说明:定义型列表由名词和解释组成。一行写上定义,紧跟一行写上解释。解释紧跟一个缩进(Tab)

代码块 1 Markdown
:    轻量级文本标记语言,可以转换成html,pdf等格式(左侧有一个可见的冒号和四个不可见的空格)

代码块 2
:   这是代码块的定义(左侧有一个可见的冒号和四个不可见的空格)

        代码块(左侧有八个不可见的空格)
代码块 1 Markdown
轻量级文本标记语言,可以转换成html,pdf等格式(左侧有一个可见的冒号和四个不可见的空格)
代码块 2
这是代码块的定义(左侧有一个可见的冒号和四个不可见的空格)

​ 代码块(左侧有八个不可见的空格)

等等等


6. 引用

语法说明:>

需要在被引用的文本前加上>符号

1
2
> 无意义的引用
> 武夷山

无意义的引用

武夷山

6.1. 引用的多层嵌套

区块引用可以嵌套,只要加上不同数量的>。

1
2
3
4
5
>>> Markdown 怎么用? - 白哥

>> 自己看教程 -愤青

> 教程在哪里? -白哥

Markdown 怎么用? - 白哥

自己看教程 -愤青

教程在哪里? -白哥

6.2. 引用其他要素

引用区块内也可以使用其他markdown语法, 包括标题、列表、代码区块等。

> 1. 这是第一行列表
> 2. 这是第二行列表
> 给出一些例子
>
> ```python
ssnsnsnnsns```
  1. 这是第一行列表
  2. 这是第二行列表

给出一些例子代码:

1
2
def my_example:
    pass

7. 插入图像

图片的创建方式与超链接相似,而且和超链接一样有两种写法,行内式和参考式写法。

语法:WangW Blog


8. 内容目录

一般标准的内容目录为[TOC]

然而,在github上README.md上的目录生成,使用以上的办法是不行的。我一般是使用一个下面的插件插件连接:github-markdown-toc.go

不过github-readme 用的是利用锚点自己写目录


9. 注脚

语法说明:

在需要添加注脚的文字后加上脚注名字[^注脚名字],称为加注。 然后在文本的任意位置(一般在最后)添加脚注,脚注前必须有对应的脚注名字。

注意:经测试注脚与注脚之间必须空一行,不然会失效。成功后会发现,即使你没有把注脚写在文末,经Markdown转换后,也会自动归类到文章的最后。

1
2
3
4
5
6
7
使用 Markdown[^1]可以效率的书写文档, 直接转换成 HTML[^2], 你可以使用 Leanote[^Le] 编辑器进行书写。

[^1]:Markdown是一种纯文本标记语言

[^2]:HyperText Markup Language 超文本标记语言

[^Le]:开源笔记平台,支持Markdown和笔记直接发为博文

使用 Markdown1可以效率的书写文档, 直接转换成 HTML2, 你可以使用 Leanote3 编辑器进行书写。


10. LaTeX 公式

自行查看

访问MathJax参考更多使用方法


11. 流程图

流程图语法参考


12. 表格

语法说明:

不管是哪种方式,第一行为表头,第二行分割表头和主体部分,第三行开始每一行为一个表格行。列于列之间用管道符 隔开。原生方式的表格每一行的两边也要有管道符。第二行还可以为不同的列指定对齐方式。默认为左对齐,在-右加上:就是右对齐了。
  1. 简单方式写表格

    1
    2
    3
    4
    5
    
    姓名|姓别|分数
    -|-|-
    小明||100
    TQ||11
    WW||100
    
    姓名 姓别 分数
    小明 100
    TQ 11
    WW 100
  2. 原生方式写表格

    1
    2
    3
    4
    5
    
    |姓名|姓别|分数|
    |-|-|-|
    |小明||100|
    |TQ||11|
    |WW||100|
    
    姓名 姓别 分数
    小明 100
    TQ 11
    WW 100
  3. 第二列指定方向

    1
    2
    3
    4
    5
    
    |姓名|姓别|分数|
    |-|-:|-|
    |小明||100|
    |TQ||11|
    |WW||100|
    
    姓名 姓别 分数
    小明 100
    TQ 11
    WW 100

13. 分割线

可以用三个以上的星号、减号、底线来建立一个分割线

1
2
3
4
*****
* * *
- - - 
-----

显示的效果都一样


14. 代码

插入代码的方式有两种,一种是利用缩进(Tab), 另一种是利用``````符号包裹代码。

语法说明:

  1. 插入行内代码,用``的方式
  2. 插入多行可用缩进或者 ``````,具体开例子

注意: 缩进式插入前方必须有空行

14.1. 行内式

python语言里的`print`怎么使用?

python语言里的print怎么使用?

14.2. 缩进或者多行代码

缩进4个空格或者1个制表符

一个代码区块会一直持续到没有缩进的哪一行。

1
2
	def TQ(name):
        pass
1
2
def TQ(name):
        pass
  1. Markdown是一种纯文本标记语言 

  2. HyperText Markup Language 超文本标记语言 

  3. 开源笔记平台,支持Markdown和笔记直接发为博文