Github 秘籍二

Markdown 文件語(yǔ)法高亮

例如，可以像下面這樣在你的 Markdown 文件里為 Ruby 代碼添加語(yǔ)法高亮：

```ruby
require 'tabbit'
table = Tabbit.new('Name', 'Email')
table.add_row('Tim Green', 'tiimgreen@gmail.com')
puts table.to_s
```

效果如下：

ruby
require 'tabbit'
table = Tabbit.new('Name', 'Email')
table.add_row('Tim Green', 'tiimgreen@gmail.com')
puts table.to_s

Github 使用 Linguist 做語(yǔ)言識(shí)別和語(yǔ)法高亮。你可以仔細(xì)閱讀 languages YAML file，了解有哪些可用的關(guān)鍵字。

進(jìn)一步了解 GitHub Flavored Markdown

表情符

可以在 Pull Requests, Issues, 提交消息, Markdown 文件里加入表情符。使用方法 :name_of_emoji:

:smile:

將輸出一個(gè)笑臉：

http://wiki.jikexueyuan.com/project/github-secret/images/smile.png" alt="" />

Github 支持的完整表情符號(hào)列表詳見 emoji-cheat-sheet.com 或 scotch-io/All-Github-Emoji-Icons。

Github 上使用最多的 5 個(gè)表情符號(hào)是：

• :shipit:
• :sparkles:
• :-1:
• :+1:
• :clap:

圖片 / GIF 動(dòng)畫

注釋和 README 等文件里也可以使用圖片和 GIF 動(dòng)畫：

![Alt Text](http://www.sheawong.com/wp-content/uploads/2013/08/keephatin.gif)

倉(cāng)庫(kù)中的圖片可以被直接引用：

![Alt Text](https://github.com/{user}/{repo}/raw/master/path/to/image.gif)

http://wiki.jikexueyuan.com/project/github-secret/images/wh.gif" alt="" />

所有圖片都緩存在 Github，不用擔(dān)心你的站點(diǎn)不能訪問(wèn)時(shí)就看不到圖片了。

在 GitHub Wiki 中引用圖片

有多種方法可以在 Wiki 頁(yè)面里嵌入圖片。既可以像上一條里那樣使用標(biāo)準(zhǔn)的 Markdown 語(yǔ)法，也可以像下面這樣指定圖片的高度或?qū)挾龋?/p>

[[ http://www.sheawong.com/wp-content/uploads/2013/08/keephatin.gif | height = 100px ]]

結(jié)果：

http://wiki.jikexueyuan.com/project/github-secret/images/gh18.png" alt="" />

快速引用

在主題評(píng)論中引用之前某個(gè)人所說(shuō)的，只需選中文本，然后按 r 鍵，想要的就會(huì)以引用的形式復(fù)制到你的輸入框里。

http://wiki.jikexueyuan.com/project/github-secret/images/gh1.gif" alt="" />

進(jìn)一步了解快速引用

粘貼剪貼板中的圖片到評(píng)論

（僅適用于 Chrome 瀏覽器）

當(dāng)截屏圖片復(fù)制到剪貼板后（mac 上用 cmd-ctrl-shift-4），你可以用(cmd-v / ctrl-v)把圖片粘貼到評(píng)論框里，然后它就會(huì)自動(dòng)上傳到 Github。

http://wiki.jikexueyuan.com/project/github-secret/images/gh19.png" alt="" />

進(jìn)一步了解在 issue 中使用附件

快速添加許可證文件

創(chuàng)建一個(gè)倉(cāng)庫(kù)時(shí)，Github 會(huì)為你提供一個(gè)預(yù)置的軟件許可列表：

http://wiki.jikexueyuan.com/project/github-secret/images/gh20.png" alt="" />

對(duì)于已有的倉(cāng)庫(kù)，可以通過(guò) web 界面創(chuàng)建文件來(lái)添加軟件許可。輸入 LICENSE 作為文件名后，同樣可以從預(yù)置的列表中選擇一個(gè)作為模板。

http://wiki.jikexueyuan.com/project/github-secret/images/gh21.png" alt="" />

這個(gè)技巧也適用于.gitignore文件。

進(jìn)一步了解開源許可證

任務(wù)列表

Issues 和 Pull requests 里可以添加復(fù)選框，語(yǔ)法如下（注意空白符）：

- [ ] Be awesome
- [ ] Prepare dinner
  - [ ] Research recipe
  - [ ] Buy ingredients
  - [ ] Cook recipe
- [ ] Sleep

http://wiki.jikexueyuan.com/project/github-secret/images/gh22.png" alt="" />

當(dāng)項(xiàng)目被選中時(shí)，它對(duì)應(yīng)的 Markdown 源碼也被更新了：

- [x] Be awesome
- [ ] Prepare dinner
  - [x] Research recipe
  - [x] Buy ingredients
  - [ ] Cook recipe
- [ ] Sleep

進(jìn)一步了解任務(wù)列表

Markdown 文件中的任務(wù)列表

在完全適配 Markdown 語(yǔ)法的文件中可以使用以下語(yǔ)法加入一個(gè)只讀的任務(wù)列表

- [ ] Mercury
- [x] Venus
- [x] Earth
  - [x] Moon
- [x] Mars
  - [ ] Deimos
  - [ ] Phobos

• [ ] Mercury
• [x] Venus
• [x] Earth
  • [x] Moon
• [x] Mars
  • [ ] Deimos
  • [ ] Phobos

進(jìn)一步了解 Markdown 文件中的任務(wù)列表

相對(duì)鏈接

Markdown 文件里鏈接到內(nèi)部?jī)?nèi)容時(shí)推薦使用相對(duì)鏈接。

[Link to a header](#awesome-section)
[Link to a file](docs/readme)

絕對(duì)鏈接會(huì)在 URL 改變時(shí)（例如重命名倉(cāng)庫(kù)、用戶名改變，建立分支項(xiàng)目）被更新。使用相對(duì)鏈接能夠保證你的文檔不受此影響。

進(jìn)一步了解相對(duì)鏈接