本秘籍收录了一些Git和Github非常酷同时又少有人知的功能。灵感来自于Zach Holman在2012年Aloha Ruby Conference和2013年WDCNZ上所做的演讲:Git and GitHub Secrets(slides)和More Git and GitHub Secrets(slides)。
Read this in other languages: English, 한국어, 日本語, 简体中文.
- GitHub
- 忽略空白字符变化
- 调整Tab字符所代表的空格数
- 查看某个用户的Commit历史
- 克隆某个仓库
- 比较分支
- 比较不同派生库的分支
- Gists
- Git.io
- 键盘快捷键
- 整行高亮
- 用commit信息关闭Issue
- 链接其他仓库的Issue
- 设置CI对每条Pull Request都进行构建
- Markdown文件高亮语法
- 表情符
- 静态与动态图片
- 快速引用
- 快速添加许可证
- 任务列表
- 相对链接
- GitHub Pages的元数据与插件支持
- 查看YAML格式的元数据
- 渲染表格数据
- Diffs
- Hub
- 贡献内容的自动检查
- 贡献者指南
- GitHub资源
- Git
- 前一个分支
- Stripspace命令
- 检出Pull Requests
- 提交空改动
- 更直观的Git Status
- 更直观的Git Log
- Git查询
- 合并分支
- 使用网页查看本地仓库
- Git配置
- Git资源
在任意diff页面的URL后加上?w=1
,可以去掉那些只是空白字符的变化,使你能更专注于代码的变化。
在diff或者file页面的URL后面加上?ts=4
,这样当显示tab字符的长度时就会是4个空格的长度,不再是默认的8个空格。ts
后面的数字还可以根据你个人的偏好进行修改。不过,这个小诀窍在Gists页面和raw file页面不起作用。
下面是我们在Go语言的source file页面URL后加?ts=4
前的例子:
然后是我们添加?ts=4
后的例子:
查看某个用户的所有提交历史,只需在commits页面URL后加上?author=username
。
https://github.com/rails/rails/commits/master?author=dhh
当我们克隆某一资源时,可以不要那个.git
后缀。
$ git clone https://github.com/tiimgreen/github-cheat-sheet
如果我们想要比较两个分支,可以像下面一样修改URL:
https://github.com/user/repo/compare/{range}
其中{range} = master...4-1-stable
例如:
https://github.com/rails/rails/compare/master...4-1-stable
{range}
还可以使用下面的形式:
https://github.com/rails/rails/compare/master@{1.day.ago}...master
https://github.com/rails/rails/compare/master@{2014-10-04}...master
日期格式 YYYY-DD-MM
...这样你就能查看master分支上一段时间或者指定日期内的改动。
想要对派生仓库(Forked Repository)之间的分支进行比较,可以像下面这样修改URL实现:
https://github.com/user/repo/compare/{foreign-user}:{branch}...{own-branch}
例如:
https://github.com/rails/rails/compare/byroot:master...master
Gists 给我们提供了一种不需要创建一个完整的仓库,使小段代码也可以工作的简单方式。
Gist的URL后加上.pibb
,可以得到更适合嵌入到其他网站的HTML版本。
Gists还可以像任何标准仓库一样被克隆。
$ git clone https://gist.github.com/tiimgreen/10545817
Git.io是Github的短网址服务。
你可以通过Curl命令以普通HTTP协议使用它:
$ curl -i http://git.io -F "url=https://github.com/..."
HTTP/1.1 201 Created
Location: http://git.io/abc123
$ curl -i http://git.io/abc123
HTTP/1.1 302 Found
Location: https://github.com/...
在仓库主页上提供了快捷键方便快速导航。
- 按
t
键会打开一个文件浏览器。 - 按
w
键会打开分支选择菜单。 - 按
s
键会激活顶端的命令栏 (Command Bar)。 - 按
l
键编辑Issue列表页的标签。 - 查看文件内容时(如:
https://github.com/tiimgreen/github-cheat-sheet/blob/master/README.md
),按y
键将会冻结这个页面,这样就算代码被修改了也不会影响你当前看到的。
按?
查看当前页面支持的快捷键列表:
在代码文件地址后加上#L52
或者单击行号52都会将第52行代码高亮显示。
多行高亮也可以,比如用#L53-L60
选择范围,或者按住 shift
键,然后再点击选择的两行。
https://github.com/rails/rails/blob/master/activemodel/lib/active_model.rb#L53-L60
如果某个提交修复了一个Issue,当提交到master分支时,提交信息里可以使用fix/fixes/fixed
, close/closes/closed
或者 resolve/resolves/resolved
等关键词,后面再跟上Issue号,这样就会关闭这个Issue。
$ git commit -m "Fix screwup, fixes #12"
这将会关闭Issue #12,并且在Issue讨论列表里关联引用这次提交。
如果你想引用到同一个仓库中的一个Issue,只需使用井号 #
加上Issue号,这样就会自动创建到此Issue的链接。
要链接到其他仓库的Issue,就使用user_name/repo_name#ISSUE_NUMBER
的方式,例如tiimgreen/toc#12
。
如果配置正确,Travis CI会为每个你收到的Pull Request执行构建,就像每次提交也会触发构建一样。想了解更多关于Travis CI的信息,请看 Travis CI入门。
例如,可以像下面这样在你的Markdown文件里为Ruby代码添加语法高亮:
```ruby
require 'tabbit'
table = Tabbit.new('Name', 'Email')
table.add_row('Tim Green', '[email protected]')
puts table.to_s
```
效果像下面这样:
require 'tabbit'
table = Tabbit.new('Name', 'Email')
table.add_row('Tim Green', '[email protected]')
puts table.to_s
Github使用 Linguist 做语言识别和语法高亮。你可以仔细阅读 languages YAML file,了解有哪些可用的关键字。
进一步了解 GitHub Flavored Markdown.
可以在Pull Requests, Issues, 提交消息, Markdown文件里加入表情符。使用方法:name_of_emoji:
:smile:
将输出一个笑脸:
😄
Github支持的完整表情符号列表详见emoji-cheat-sheet.com 或 scotch-io/All-Github-Emoji-Icons。
Github上使用最多的5个表情符号是:
- -
:shipit:
- ✨ -
:sparkles:
- 👎 -
:-1:
- 👍 -
:+1:
- 👏 -
:clap:
注释和README等文件里也可以使用图片和GIF动画:
![Alt Text](http://www.sheawong.com/wp-content/uploads/2013/08/keephatin.gif)
所有图片都缓存在Gitub,不用担心你的站点不能访问时就看不到图片了。
有多种方法可以在Wiki页面里嵌入图片。既可以像上一条里那样使用标准的Markdown语法,也可以像下面这样指定图片的高度或宽度:
[[ http://www.sheawong.com/wp-content/uploads/2013/08/keephatin.gif | height = 100px ]]
结果:
在注释话题里引用之前某个人所说的,只需选中文本,然后按 r
键,想要的就会以引用的形式复制到你的输入框里。
创建一个仓库时,Github会为你提供一个预置的软件许可列表:
对于已有的仓库,可以通过web界面创建文件来添加软件许可。输入LICENSE
作为文件名后,同样可以从预置的列表中选择一个作为模板。
这个技巧也使用于 .gitignore
文件。
Issues和Pull requests里可以添加复选框,语法如下(注意空白符):
- [ ] Be awesome
- [ ] Do stuff
- [ ] Sleep
当项目被选中时,它对应的Markdown源码也被更新了:
- [x] Be awesome
- [x] Do stuff
- [ ] Sleep
Markdown文件里链接到内部内容时推荐使用相对链接。
[Link to a header](#awesome-section)
[Link to a file](docs/readme)
绝对链接会在URL改变时(例如重命名仓库、用户名改变,建立分支项目)被更新。使用相对链接能够保证你的文档不受此影响。
在Jekyll页面和文章里,仓库信息可在 site.github
命名空间下找到,也可以显示出来,例如,使用 {{ site.github.project_title }}
显示项目标题。
Jemoji和jekyll-mentions插件为你的Jekyll文章和页面增加了emoji和@mentions功能。
许多博客站点,比如基于Jekyll的GitHub Pages,都依赖于一些文章头部的YAML格式的元数据。Github会将其渲染成一个水平表格,方便阅读。
GitHub支持将 .csv
(comma分隔)和.tsv
(tab分隔)格式的文件渲染成表格数据。
提交和Pull Requests里包含有Github支持的可渲染文档(比如Markdown)会提供source 和 rendered 两个视图功能。
点击 "rendered" 按钮,看看改动在渲染后的显示效果。当你添加、删除或修改文本时,渲染纯文本视图非常方便。
当你在GitHub上查看一个包含地理数据的提交或pull request时,Github可以显示数据变动的视觉表示。
你可以通过点击diff边栏里的 unfold 按钮来多显示几行上下文。你可以一直点击 unfold 按钮直到显示了文件的全部内容。这个功能在所有GitHub产生的diff界面都可以使用。
在Pull Request的URL后面加上 .diff
或 .patch
的扩展名就可以得到它的diff或patch文件,例如:
https://github.com/tiimgreen/github-cheat-sheet/pull/15
https://github.com/tiimgreen/github-cheat-sheet/pull/15.diff
https://github.com/tiimgreen/github-cheat-sheet/pull/15.patch
.diff
扩展会使用普通文本格式显示如下内容:
diff --git a/README.md b/README.md
index 88fcf69..8614873 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,7 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i
- [Merged Branches](#merged-branches)
- [Quick Licensing](#quick-licensing)
- [TODO Lists](#todo-lists)
+- [Relative Links](#relative-links)
- [.gitconfig Recommendations](#gitconfig-recommendations)
- [Aliases](#aliases)
- [Auto-correct](#auto-correct)
@@ -381,6 +382,19 @@ When they are clicked, they will be updated in the pure Markdown:
- [ ] Sleep
(...)
Hub是一个对Git进行了封装的命令行工具,可以帮助你更方便的使用Github。
这使得你可以像下面这样进行克隆:
$ hub clone tiimgreen/toc
假设你想人们使用你的项目并给你的项目做出贡献,你往往需要回答他们常见问题。这个项目是干什么用的?我如何使用它?允许我怎样使用?我如何为项目出力?我怎样配置开发环境?我怎么能保证新功能不会破坏已有的功能?
Friction是一个命令行脚本,用来检查你的项目是否回答了这些问题。下面是示例输出:
Friction 支持 MRI 2.1.0, MRI 2.0.0 和 MRI 1.9.3.
在你的仓库的根目录添加一个名为 CONTRIBUTING
的文件后,贡献者在新建Issue或Pull Request时会看到这个文件的链接。
Title | Link |
---|---|
GitHub Explore | https://github.com/explore |
GitHub Blog | https://github.com/blog |
GitHub Help | https://help.github.com/ |
GitHub Training | http://training.github.com/ |
GitHub Developer | https://developer.github.com/ |
Title | Link |
---|---|
How GitHub Uses GitHub to Build GitHub | https://www.youtube.com/watch?v=qyz3jkOBbQY |
Introduction to Git with Scott Chacon of GitHub | https://www.youtube.com/watch?v=ZDR433b0HJY |
How GitHub No Longer Works | https://www.youtube.com/watch?v=gXD1ITW7iZI |
Git and GitHub Secrets | https://www.youtube.com/watch?v=Foz9yvMkvlA |
More Git and GitHub Secrets | https://www.youtube.com/watch?v=p50xsL-iVgU |
快速检出上一个分支:
$ git checkout -
# Switched to branch 'master'
$ git checkout -
# Switched to branch 'next'
$ git checkout -
# Switched to branch 'master'
Git Stripspace命令可以:
- 去掉行尾空白符
- 多个空行压缩成一行
- 必要时在文件末尾增加一个空行
使用此命令时必须传入一个文件,像这样:
$ git stripspace < README.md
如果想检出pull requests到本地,可以先用下面的fetch命令:
$ git fetch origin '+refs/pull/*/head:refs/pull/*'
然后用checkout命令检查想要的Pull Request(比如42)
$ git checkout refs/pull/42
你也可以把它们当作远程分支来fetch:
$ git fetch origin '+refs/pull/*/head:refs/remotes/origin/pr/*'
然后这样检出:
$ git checkout origin/pr/42
或者干脆在你的.git/config文件里添加如下内容,这样就可以自动获取它们了。
[remote "origin"]
fetch = +refs/heads/*:refs/remotes/origin/*
url = [email protected]:tiimgreen/github-cheat-sheet.git
[remote "origin"]
fetch = +refs/heads/*:refs/remotes/origin/*
url = [email protected]:tiimgreen/github-cheat-sheet.git
fetch = +refs/pull/*/head:refs/remotes/origin/pr/*
可以使用--allow-empty
选项强制创建一个没有任何改动的提交:
$ git commit -m "Big-ass commit" --allow-empty
这样做在如下几种情况下是有意义的:
- 标记一批工作或一个新功能的开始。
- 记录你对项目进行了跟代码无关的改动。
- 跟使用你仓库的其他人交流。
- 作为仓库的第一次提交,因为第一次提交日后是不能被rebase的:
git commit -m "init repo" --allow-empty
.
在命令行输入如下命令:
$ git status
可以看到:
加上-sb
选项:
$ git status -sb
这回得到:
输入如下命令:
$ git log --all --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --date=relative
可以看到:
这要归功于Palesz在stackoverflow的回答。
这个命令可以被用作别名,详细做法见这里。
Git查询运行你在之前的所有提交信息里进行搜索,找到其中和搜索条件相匹配的最近的一条。
$ git show :/query
这里 query
(区别大小写)是你想要搜索的词语, 这条命令会找到包含这个词语的最后那个提交并显示变动详情。
$ git show :/typo
- 按
q
键退出命令。*
输入命令:
$ git branch --merged
这会显示所有已经合并到你当前分支的分支列表。
相反地:
$ git branch --no-merged
会显示所有还没有合并到你当前分支的分支列表。
使用Git的 instaweb
可以立即在 gitweb
中浏览你的工作仓库。这个命令是个简单的脚步,配置了gitweb
和用来浏览本地仓库的Web服务器。(译者注:默认需要lighttpd支持)
$ git instaweb
执行后打开:
所有Git配置都保存在你的.gitconfig
文件中。
别名用来帮助你定义自己的git命令。比如你可以定义 git a
来运行 git add --all
。
要添加一个别名, 一种方法是打开 ~/.gitconfig
文件并添加如下内容:
[alias]
co = checkout
cm = commit
p = push
# Show verbose output about tags, branches or remotes
tags = tag -l
branches = branch -a
remotes = remote -v
...或者在命令行里键入:
$ git config --global alias.new_alias git_function
例如:
$ git config --global alias.cm commit
指向多个命令的别名可以用引号来定义:
$ git config --global alias.ac 'add -A . && commit'
下面列出了一些有用的别名:
别名 Alias | 命令 Command | 如何设置 What to Type |
---|---|---|
git cm |
git commit |
git config --global alias.cm commit |
git co |
git checkout |
git config --global alias.co checkout |
git ac |
git add . -A git commit |
git config --global alias.ac '!git add -A && git commit' |
git st |
git status -sb |
git config --global alias.st 'status -sb' |
git tags |
git tag -l |
git config --global alias.tags 'tag -l' |
git branches |
git branch -a |
git config --global alias.branches 'branch -a' |
git remotes |
git remote -v |
git config --global alias.remotes 'remote -v' |
如果键入 git comit
你会看到如下输出:
$ git comit -m "Message"
# git: 'comit' is not a git command. See 'git --help'.
# Did you mean this?
# commit
为了在键入 comit
调用 commit
命令,只需启用自动纠错功能:
$ git config --global help.autocorrect 1
现在你就会看到:
$ git comit -m "Message"
# WARNING: You called a Git command named 'comit', which does not exist.
# Continuing under the assumption that you meant 'commit'
# in 0.1 seconds automatically...
要在你的Git命令输出里加上颜色的话,可以用如下命令:
$ git config --global color.ui 1
Title | Link |
---|---|
Official Git Site | http://git-scm.com/ |
Official Git Video Tutorials | http://git-scm.com/videos |
Code School Try Git | http://try.github.com/ |
Introductory Reference & Tutorial for Git | http://gitref.org/ |
Official Git Tutorial | http://git-scm.com/docs/gittutorial |
Everyday Git | http://git-scm.com/docs/everyday |
Git Immersion | http://gitimmersion.com/ |
Ry's Git Tutorial | http://rypress.com/tutorials/git/index.html |
Git for Designer | http://hoth.entp.com/output/git_for_designers.html |
Git for Computer Scientists | http://eagain.net/articles/git-for-computer-scientists/ |
Git Magic | http://www-cs-students.stanford.edu/~blynn/gitmagic/ |
Title | Link |
---|---|
Pragmatic Version Control Using Git | http://www.pragprog.com/titles/tsgit/pragmatic-version-control-using-git |
Pro Git | http://git-scm.com/book |
Git Internals Peepcode | http://peepcode.com/products/git-internals-pdf |
Git in the Trenches | http://cbx33.github.com/gitt/ |
Version Control with Git | http://www.amazon.com/Version-Control-Git-collaborative-development/dp/1449316387 |
Pragmatic Guide to Git | http://www.pragprog.com/titles/pg_git/pragmatic-guide-to-git |
Git: Version Control for Everyone | http://www.packtpub.com/git-version-control-for-everyone/book |