Github上的Markdown语法

大标题

只需在想成为大标题的文字下一行加上多个=符号就可以了

中标题

只需在想成为中标题的文字下一行加上多个-就可以了。如下:

中标题

每级标题

用1~6个#符号加上空格后接标题名就好了

一级标题

二级标题

三级标题

四级标题

五级标题

六级标题

文本框

有时候我们希望某个段落的文字能按照我们排好的方式在网页上显示，这时候就用到文本框了，只要缩进两个空格或更多再输入文字就是文本框，文本框会持续到没有缩进为止如下：

这是一个单行文本框

下面是多行文本框：

这两段不是文本框的效果

此处我在本地缩进了

此处我没有缩进

多行文本框的第一行

此处我缩进了

此处我缩进了两倍 不知道为啥没用

导航目录

在你需要生成目录的地方加上[toc]就可以了，它会自动将所有标题按层级关系展示。如开头部分

链接

格式1：[显示文字](目标网址)

格式2：在需要放链接的地方放两个中括号，在另一个地方提供相应网址。如下：

some text with [link][1] and another [link][2]

[1]: "url"

[2]: "url"

中括号后面加小括号，中括号里输入目标网址的提示信息，小括号输入目标网址，如google

自动链接

只需把网址或电子邮件用尖括号括起来即可，如https://www.baidu.com

显示图片

格式1

： ![可选文本](图片地址,"鼠标悬浮显示文字")

格式2

：和网址的格式2差不多，多了个惊叹号

small log: ![Alt text][1]

[1]: url

示例：

当图片无法显示的时候就显示可选文本代替

显示可点击图片

格式1：[![alt text]](/wp-smaller.png)](https://www.github.com/ "鼠标悬停显示文字")
格式2：

![图片加载失败时显示的文字][text]
[text]:url "鼠标悬浮时显示的文字"

引用文字

在文字前面加上>即可。如下：

引用开始

引用结束

加上多个>是多层引用。如下：

首层引用

二层引用

三层引用

换行

有时候我们明明换行了但到了网页上就合并了，这时候为了确保换行你只要在需要换行的地方加上两个空格然后回车就可以了

特殊字符处理

有些特殊字符你想当做普通字符对待，只要在字符前加上转义字符反斜杠即可。如下：显示*星号*

列表显示

用*,+ -加空格即可。如下

星号1
星号2

加号1
加号2

减号1
减号2

有序列表

数字加上英文的句号加空格即可
这是第二个

分级列表

在每一级前面加tab。如下：

星号1
- 子星号1
- 子星号2

分割线

你可以在一行中用三个或以上的星号、减号、下划线来建立一个分割线，行内不能由其它东西。你也可以在信号中间插入空白。下面每种都可以

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

如下：尝试分割线

结束分割线

强调

用两个*或_包起开等于斜体，用四个等于更加强调，示例如下：

斜体

加强

代码

行内代码：

：将代码放在``中间就可以了，这是esc下面的反引号

示例：puts("hello,world");

代码区:

：在代码的首位行指定大于等于三个`或~就可以了

示例：

#include<stdio.h>
int main(void)
{
  puts("hello,world");
  return 0;
}

代码高亮:

：用三个反引号加上编程语言名字然后换行输入代码，在代码结束时也输入三个反引号表示结束。如下：

```program language

code

```

示例：

#include<stdio.h>
int main(void)
{
    puts("hello,world");
    return 0;
}//c代码

文本内跳转

维基百科上经常可以看到行内跳转，用法如下：

其实每个标题都默认是锚点，比如我使用[回到顶部](#标题名,字母可小写)效果如下：

回到顶部

diff语法

版本控制系统中都有diff的功能，显示修改前后的差异，GFM(github format markdown)中也可以，绿色表示新增，红色表示删除。用法和代码高亮类似，但是把编程语言名换为diff即可。示例：

+新增内容
-删除内容

脚注

形式如[^1],然后在另一处增加如下所示形式的对应脚注：

[^1]: 脚注内容

注意:冒号和后面的文字间有个空格，而且脚注内容永远在文件的底部显示

示例如下：

I am iron man¹ .

表格

格式如下：

First Header | Second Header

-------------- | -----------------

Content Cell | Content Cell

你也可以在两侧都加上竖线，只是作用一样，反而增加了输入

你可以在第二行任意一列加冒号来实现相应的列对齐，如下：

左对齐： | :-------------- | ------------- |

右对齐 | ---------------: | ----------- |

居中对齐 | :--------------: | ---------- |

下定义

给某些此下定义的方法如下三种：

定义词

: 定义语句

第一个定义词

第二个定义词

: 定义语句

定义词

: 可以给多个定义语句

: 第二个定义语句

示例：

Wordpress

: A semantic personal

删除线

在需要删除线的文字前后加上两个~即可。示例：

~~删除线~~

~~删除线~~

缩略语

有时候我们仅仅给出了某个句子的缩略语，你只要点击一下这个缩略语它的全意就会显示出来。格式如下：

Markdown converts text to HTML.

*[HTML]: HyperText Markup Language

示例：

Markdown converts text to HTML

*[HTML]: Hyper Text Markup Language

缩略语和脚注可能github上不支持，我是参考的wordpress上的

参考网址：

较全面的参考但不全

wordpress上的参考与上面互为补充

官方markdown语法

基于php的markdown扩展需要php5.3以上并且有php markdown lib 1.7.0。这可能就是github不支持脚注和缩略语的原因吧

github的markdown与原始的markdown区别

github issue,评论,pull request的扩展功能,这些地方也支持markdown

不知名网友小哥的参考

若哪里不对或不全还望各位前辈指正，markdown我并没有深入，仅仅作为一个写作的工具

a hero belongs to marval ↩

Peterhaiker/Markdown-