Github 秘笈系列 (二) – 更多 Github 隱藏和實用神秘功能!!

早前已經跟大家分享過部分 Github 實用的神秘功能~現在就繼續分享其他的 Github 隱藏和實用神秘功能

原文 : https://github.com/tiimgreen/github-cheat-sheet/blob/master/README.zh-cn.md

繁化 : NitroXenon

整行高亮

在代碼文件地址 URL 後加上 #L52或者單擊行號 52 都會將第 52 行代碼高亮顯示。

多行高亮也可以,比如用 #L53-L60選擇範圍,或者按住 shift 鍵,然後再點擊選擇的兩行。

https://github.com/rails/rails/blob/master/activemodel/lib/active_model.rb#L53-L60

整行高亮

用 Commit 信息關閉 Issue

如果某個提交修復了一個 Issue,當提交到 master 分支時,提交信息裡可以使用 fix/fixes/fixed, close/closes/closed 或者 resolve/resolves/resolved 等關鍵詞,後面再跟上 Issue 號,這樣就會關閉這個 Issue 。

bash$ git commit -m "Fix screwup, fixes #12"

這將會關閉 Issue #12,並且在 Issue 討論列表裡關聯引用這次提交。

Closing Repo

進一步了解通過提交信息關閉 Issue.

鏈接其他倉庫的 Issue

如果你想引用到同一個倉庫中的一個 Issue,只需使用井號 # 加上 Issue 號,這樣就會自動創建到此 Issue 的鏈接。

要鏈接到其他倉庫的 Issue ,就使用 {user}/{repo}#ISSUE_NUMBER的方式,例如 tiimgreen/toc#12

Cross-Link Issues

鎖定項目對話功能

現在倉庫的管理員和合作者可以將 Pull Requests 和 Issue 的評論功能關閉。

github-secret-2-1

這樣,不是項目合作者的用戶就不能在這個項目上使用評論功能。

github-secret-2-2

進一步了解對話鎖定功能.

設置 CI 對每條 Pull Request 都進行構建

如果配置正確,Travis CI 會為每個你收到的 Pull Request 執行構建,就像每次提交也會觸發構建一樣。想了解更多關於 Travis CI 的信息,請參考 Travis CI入門

github-secret-2-3

進一步了解提交狀態 API.

Markdown 文件語法高亮

例如,可以像下面這樣在你的 Markdown 文件裡為 Ruby 代碼添加語法高亮:

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

效果如下:

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

Github使用 Linguist 做語言識別和語法高亮。你可以仔細閱讀 languages YAML file,了解有哪些可用的關鍵字。

進一步了解 GitHub Flavored Markdown.

表情符

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

:smile:
將輸出一個笑臉:

🙂

Github 支持的完整表情符號列表詳見emoji-cheat-sheet.comscotch-io/All-Github-Emoji-Icons

Github 上使用最多的5個表情符號是:

  1. :shipit:
  2. :sparkles:
  3. :-1:
  4. :+1:
  5. :clap:

圖片 / GIF 動畫

注釋和README等文件裡也可以使用圖片和 GIF 動畫:

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

倉庫中的圖片可以被直接引用:

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

Peter don't care

所有圖片都緩存在 Github,不用擔心你的站點不能訪問時就看不到圖片了。

在 GitHub Wiki 中引用圖片

有多種方法可以在 Wiki 頁面裡嵌入圖片。既可以像上一條裡那樣使用標準的 Markdown 語法,也可以像下面這樣指定圖片的高度或寬度:

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

Just a screenshot

快速引用

在主題評論中引用之前某個人所說的,只需選中文本,然後按 r 鍵,想要的就會以引用的形式複製到你的輸入框裡。

Quick Quote

進一步了解快速引用.

粘貼剪貼板中的圖片到評論

(僅適用於 Chrome 瀏覽器)

當截屏圖片複製到剪貼板後(mac 上用 cmd-ctrl-shift-4),你可以用( cmd-v / ctrl-v)把圖片粘貼到評論框裡,然後它就會自動上傳到 Github。

github-secret-2-4

進一步了解在 issue 中使用附件

快速添加許可證文件

創建一個倉庫時,Github會為你提供一個預置的軟件許可列表:

License

對於已有的倉庫,可以通過 web 界面創建文件來添加軟件許可。輸入 LICENSE作為文件名後,同樣可以從預置的列表中選擇一個作為模板。

License

這個技巧也適用於 .gitignore 文件。

進一步了解開源許可證

任務列表

Issues 和 Pull requests 裡可以添加複選框,語法如下(注意空白符):

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

Task List

當項目被選中時,它對應的 Markdown 源碼也被更新了:

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

進一步了解任務列表.

Markdown 文件中的任務列表

在完全適配Markdown語法的文件中可以使用以下語法加入一個只讀的任務列表

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

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

進一步了解 Markdown 文件中的任務列表

相對鏈接

Markdown文件裡鏈接到內部內容時推薦使用相對鏈接。

markdown[Link to a header](#awesome-section)[Link to a file](docs/readme)
絕對鏈接會在 URL 改變時(例如重命名倉庫、用戶名改變,建立分支項目)被更新。使用相對鏈接能夠保證你的文檔不受此影響。

進一步了解相對鏈接.

GitHub Pages 的元數據與插件支持

在 Jekyll 頁面和文章裡,倉庫信息可在 site.github 命名空間下找到,也可以顯示出來,例如,使用 {{ site.github.project_title }}顯示項目標題。

Jemoji 和 jekyll-mentions 插件為你的 Jekyll 文章和頁面增加了emoji@mentions功能。

了解更多 GitHub Pages 的元數據和插件支持.

查看 YAML 格式的元數據

許多博客站點,比如基於 JekyllGitHub Pages ,都依賴於一些文章頭部的 YAML 格式的元數據。 Github 會將其渲染成一個水平表格,方便閱讀。

YAML metadata

進一步了解 在文檔裡查看 YAML 元數據.

渲染表格數據

GitHub 支持將 .csv (逗號分隔)和 .tsv (制表符分隔)格式的文件渲染成表格數據。

Tabular data

進一步了解渲染表格數據.