Markdown是一个轻量易用的语法，用于给Github平台上各种形式的写作提供样式。

你可以从这里获得如下的东西：

Markdown格式如何使样式化协作编辑变得容易
Markdown与传统格式化方法的区别
如何使用Markdown格式化文本
IT侠推荐的工具和使用规范
如何利用GitHub的自动Markdown渲染
如何运用GitHub独特的Markdown扩展

什么是 Markdown?

Markdown 是一种在网页上样式化文本的方式。你可以控制文本的显示样式，常见的功能如对字词进行加粗或者变斜，添加图片或者列表。绝大部分情况下，Markdown除了少部分控制字符之外都是常规的文本。特殊字符举例如#或者*等，各有各的功能。

你可以在Github的很多地方使用Markdown:

Gists（雨我们无瓜）
Comments in Issues 以及 Pull Requests（同样无瓜）
以 .md 或 .markdown 结尾的文件

更多信息见GitHub Help 中的 “Writing on GitHub”。

语法举例

这个是 **加粗** 然后这个是 *斜体* 。 你想弄一个 [到Google的链接](http://google.com) 也可以，虽然你进不去。

这个是加粗然后这个是斜体。你想弄一个到Google的链接也可以，虽然你进不去。

有序列表:

1. 打上数字
2. 加个.
3. 再加一个空格

无序列表:

* 可以敲一个*
* 再来一行

除了*之外,

- 短横杠也是可以的
- 通过缩进增加列表的层级
  - 带上你的游标卡尺
  - 可以用Tab键或者空格

有序列表:

打上数字
加个.
再加一个空格

无序列表:

可以敲一个*
再来一行

除了*之外,

短横杠也是可以的
通过缩进增加列表的层级
- 带上你的游标卡尺
- 可以用Tab键或者空格

如果你想添加图片可以这么干：英文!号+方括号+小括号

![方框里面取个名字](https://itxia.site/static/images/logo.jpg)

如果你想添加图片可以这么干：英文!号+方括号+小括号

# 一级标题

为了让文章的结构更加清晰，标题是很有帮助的。 用 `#` 开始一行来创建标题。 更多的 `##` 会产生更小的标题。

### 三级标题

最多最多，可以用六个#号。

如果你想引用一些名人名言, 可以在行的开头使用 `>` 号:

> 我柠檬了。今天你柠檬了吗？
> - 柠檬侠

一级标题

为了让文章的结构更加清晰，标题是很有帮助的。用 # 开始一行来创建标题。多个 ## 会产生更小的标题。

三级标题

最多最多，可以用六个 # 号。

如果你想引用一些名人名言, 可以在行的开头使用 > 号:

我柠檬了。今天你柠檬了吗？ - 柠檬侠

在Github上有几种插入代码块的写法。行内的使用反点: `var example = true`.  如果你需要一大块代码，可以用四个空格缩进:

    if (isAwesome){
      return true
    }

不使用缩进的方式也是支持的，小编认为这种方式会更加合适：

```
if (isAwesome){
  return true
}
```

如果你需要语法高亮只要把对应的语言写上就可以了：

```javascript
if (isAwesome){
  return true
}
```

在Github上有几种插入代码块的写法。行内的使用反点: var example = true. 如果你需要一大块代码，可以用四个空格缩进:

if (isAwesome){
  return true
}

G不使用缩进的方式也是支持的，小编认为这种方式会更加合适：

if (isAwesome){
  return true
}

如果你需要语法高亮只要把对应的语言写上就可以了：

if (isAwesome){
  return true
}

Github上支持的Markdown版本为我们提供了一些额外的功能用来引用Github上的用户。但这些可能跟我们没有什么关系~

如果你想艾特IT侠你就 @itxia 就好了

任务列表是个好功能，任务前面可以用这种方式打勾:

- [x] 我好了
- [ ] 搞快点

如果你在某个Issue的评论中使用任务聊表，甚至还可以生成进度条。在Pull Requests里面也可以用。

emoji也是可以用滴!

GGithub上支持的Markdown版本为我们提供了一些额外的功能用来引用Github上的用户。但这些可能跟我们没有什么关系~

如果你想艾特IT侠你就 @itxia就好了。

任务列表是个好功能，任务前面可以用这种方式打勾:

我好了
搞快点

如果你在某个Issue的评论中使用任务聊表，甚至还可以生成进度条。在Pull Requests里面也可以用。

emoji也是可以用滴!

基本语法

这里是Github支持的Markdown的语法列表，IT侠文档中推荐的规范也会在下面指出。

标题

# 一级标题对应HTML中的 <h1> 标签
## 文章推荐从大到小依次使用标题
###### 最小的是 <h6> 标签 

                

着重

*星号可以有斜体效果*
_一个短下划线也可以_

**两个的话就是粗体了**
__两个符号换着用，但小编推荐斜体和加粗使用星号__

_你也 **可以** 把它们嵌套起来_

列表

无序列表

* Item 1
* Item 2
  * Item 2a
  * Item 2b

                

有序列表

Item 1
Item 2
Item 3
Item 3a
Item 3b

                

图片

![IT侠 Logo](https://itxia.site/static/images/logo.jpg)
格式: ![显示不出图片时的文本](图片url)

链接

http://github.com - 敲一个链接也是可以的
[GitHub](http://github.com)
[链接名称](url)

                

引用

正如邪恶的IT侠所说：

> 我不是，我没有
> 我啥也没说！

行内代码块

行内的代码块用反点：`hello`

多行代码块

多行的代码块用三个反点：
```
hello
```

                

GitHub特有的Markdown扩展

GitHub.com 使用了自己的Markdown语法版本，提供了一系列额外的功能。我们在Github上使用Markdown就有机会用到它们。

这里只是指Github上有的扩展语法的集合，并不代表别的Markdown工具平台没有，但它们都是对基本的Markdown语法的扩展。

当然，与项目中的代码提交，Issue和Pull Request相关的功能可能在文本编辑这个用途上应该是用不到的。

语法高亮

这是一个可以使用语法高亮的例子。同时提供一个链接 GitHub Flavored Markdown

```javascript
function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}
```

                

代码块也可以通过代码缩进来实现:

    function fancyAlert(arg) {
      if(arg) {
        $.facebox({div:'#foo'})
      }
    }

                

这是一个高亮的Python代码，虽然我看不出来:

def foo():
    if not bar:
        return True

                

任务列表

- [x] 记住这个语法
- [x] 就可以用了
- [x] 嗯
- [ ] 啊

                

If you include a task list in the first comment of an Issue, you will get a handy progress indicator in your issue list. It also works in Pull Requests!

表格

可以用竖线和短杠等等符号组成一个表格。 - 用在标题下面, |用来分割不同的列:

标题一 | 标题二
------------ | -------------
内容在这里 | 在这里
还有这里 | 还有这里

                

效果如下:

标题一	标题二
内容在这里	在这里
还有这里	还有这里

SHA 引用

如果你引用某次代码提交的 SHA-1 hash 会自动创建指向这次提交的链接。

16c999e8c71134401a78d4d46435517b2271d6ac
mojombo@16c999e8c71134401a78d4d46435517b2271d6ac
mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac

                

在一个repository中引用Issue

使用Issue或者PR的标号可以产生一个链接。如果只是文档编写可以无视这个功能。

#1
mojombo#1
mojombo/github-flavored-markdown#1

                

@用户名

输入一个 @ 符号, 跟上一个用户名, 和QQ上是差不多的效果。这个功能叫 “@mention”, 因为你提到了这个特定的用户。当然，除了个人账号，组织账号也是可以的。

URL的自动链接

如果你直接放一个URL： http://www.github.com/ 它会变成一个可以点击的链接。

删除线

如果你想撤回你说的话，可以这么干： ~~啊我被删了~~ 。

Emoji

Github也支持 emoji!

不介绍，有兴趣去 Emoji Cheat Sheet看一看。

在线工具

最后提供一个在线的工具给大家玩，上面是输入框，下面是生成的效果，可以试一试啦。

最近编辑于2019年6月7日

掌握 Markdown