lists/github-cheat-sheet
1
0
Fork 0
mirror of https://github.com/tiimgreen/github-cheat-sheet.git synced 2025-10-06 03:11:33 +02:00
Code Issues Releases Wiki Activity

Fix link issues as highlighted in #144

Browse Source
This commit is contained in:
Tim Green
2015-12-30 01:54:34 +00:00
parent 38f511fbc1
commit 21e084d6dc
1 changed files with 21 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@@ -1,5 +1,5 @@
# GitHub Cheat Sheet [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) # GitHub Cheat Sheet [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
A collection of cool hidden and not so hidden features of Git and GitHub. This cheat sheet was inspired by [Zach Holman](https://github.com/holman)'s [Git and GitHub Secrets](http://www.confreaks.com/videos/1229-aloharuby2012-git-and-github-secrets) talk at Aloha Ruby Conference 2012 ([slides](https://speakerdeck.com/holman/git-and-github-secrets)) and his [More Git and GitHub Secrets](https://vimeo.com/72955426) talk at WDCNZ 2013 ([slides](https://speakerdeck.com/holman/more-git-and-github-secrets)). A collection of cool hidden and not so hidden features of Git and GitHub. This cheat sheet was inspired by [Zach Holman](https://github.com/holman)'s [Git and GitHub Secrets](http://www.http://confreaks.tv/videos/aloharuby2012-git-and-github-secrets) talk at Aloha Ruby Conference 2012 ([slides](https://speakerdeck.com/holman/git-and-github-secrets)) and his [More Git and GitHub Secrets](https://vimeo.com/72955426) talk at WDCNZ 2013 ([slides](https://speakerdeck.com/holman/more-git-and-github-secrets)).
*Shortlink: [`http://git.io/sheet`](http://git.io/sheet)* *Shortlink: [`http://git.io/sheet`](http://git.io/sheet)*
@@ -82,7 +82,7 @@ Adding `?w=1` to any diff URL will remove any changes only in whitespace, enabli
[*Read more about GitHub secrets.*](https://github.com/blog/967-github-secrets) [*Read more about GitHub secrets.*](https://github.com/blog/967-github-secrets)
### Adjust Tab Space ### Adjust Tab Space
Adding `?ts=4` to a diff or file URL will display tab characters as 4 spaces wide instead of the default 8. The number after `ts` can be adjusted to suit your preference. This does not work on Gists, or raw file views, but a [Chrome](https://chrome.google.com/webstore/detail/github-tab-size/ofjbgncegkdemndciafljngjbdpfmbkn) or [Opera extension](https://addons.opera.com/en/extensions/details/github-tab-size/) can automate this. Adding `?ts=4` to a diff or file URL will display tab characters as 4 spaces wide instead of the default 8. The number after `ts` can be adjusted to suit your preference. This does not work on Gists, or raw file views, but a [Chrome](https://chrome.google.com/webstore/detail/tab-size-on-github/ofjbgncegkdemndciafljngjbdpfmbkn) or [Opera extension](https://addons.opera.com/en/extensions/details/github-tab-size/) can automate this.
Here is a Go source file before adding `?ts=4`: Here is a Go source file before adding `?ts=4`:
@@ -101,7 +101,7 @@ https://github.com/rails/rails/commits/master?author=dhh
![DHH commit history](http://i.imgur.com/S7AE29b.png) ![DHH commit history](http://i.imgur.com/S7AE29b.png)
[*Read more about the differences between commits views.*](https://help.github.com/articles/differences-between-commit-views) [*Read more about the differences between commits views.*](https://help.github.com/articles/differences-between-commit-views/)
### Cloning a Repository ### Cloning a Repository
When cloning a repository the `.git` can be left off the end. When cloning a repository the `.git` can be left off the end.
@@ -162,7 +162,7 @@ https://github.com/rails/rails/compare/master...4-1-stable.diff
https://github.com/rails/rails/compare/master...4-1-stable.patch https://github.com/rails/rails/compare/master...4-1-stable.patch
``` ```
[*Read more about comparing commits across time.*](https://help.github.com/articles/comparing-commits-across-time) [*Read more about comparing commits across time.*](https://help.github.com/articles/comparing-commits-across-time/)
#### Compare Branches across Forked Repositories #### Compare Branches across Forked Repositories
To use GitHub to compare branches across forked repositories, change the URL to look like this: To use GitHub to compare branches across forked repositories, change the URL to look like this:
@@ -204,7 +204,7 @@ Password for 'https://tiimgreen@gist.github.com':
``` ```
However, Gists do not support directories. All files need to be added to the repository root. However, Gists do not support directories. All files need to be added to the repository root.
[*Read more about creating Gists.*](https://help.github.com/articles/creating-gists) [*Read more about creating Gists.*](https://help.github.com/articles/creating-gists/)
### Git.io ### Git.io
[Git.io](http://git.io) is a simple URL shortener for GitHub. [Git.io](http://git.io) is a simple URL shortener for GitHub.
@@ -262,7 +262,7 @@ This closes the issue and references the closing commit.
![Closing Repo](http://i.imgur.com/Uh1gZdx.png) ![Closing Repo](http://i.imgur.com/Uh1gZdx.png)
[*Read more about closing Issues via commit messages.*](https://help.github.com/articles/closing-issues-via-commit-messages) [*Read more about closing Issues via commit messages.*](https://help.github.com/articles/closing-issues-via-commit-messages/)
### Cross-Link Issues ### Cross-Link Issues
If you want to link to another issue in the same repository, simply type hash `#` then the issue number, and it will be auto-linked. If you want to link to another issue in the same repository, simply type hash `#` then the issue number, and it will be auto-linked.
@@ -311,7 +311,7 @@ can also see merged pull requests. Just put the following in the filter:
`is:merged` `is:merged`
[*Read more about searching issues.*](https://help.github.com/articles/searching-issues) [*Read more about searching issues.*](https://help.github.com/articles/searching-issues/)
Finally, github now allows you to filter by the Status API's status. Finally, github now allows you to filter by the Status API's status.
@@ -342,7 +342,7 @@ puts table.to_s
GitHub uses [Linguist](https://github.com/github/linguist) to perform language detection and syntax highlighting. You can find out which keywords are valid by perusing the [languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml). GitHub uses [Linguist](https://github.com/github/linguist) to perform language detection and syntax highlighting. You can find out which keywords are valid by perusing the [languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
[*Read more about GitHub Flavored Markdown.*](https://help.github.com/articles/github-flavored-markdown) [*Read more about GitHub Flavored Markdown.*](https://help.github.com/articles/github-flavored-markdown/)
### Emojis ### Emojis
Emojis can be added to Pull Requests, Issues, commit messages, repository descriptions, etc. using `:name_of_emoji:`. Emojis can be added to Pull Requests, Issues, commit messages, repository descriptions, etc. using `:name_of_emoji:`.
@@ -401,7 +401,7 @@ After taking a screenshot and adding it to the clipboard (mac: `cmd-ctrl-shift-4
![Pasting Clipboard Image to Comments](https://cloud.githubusercontent.com/assets/39191/5794265/39c9b65a-9f1b-11e4-9bc7-04e41f59ea5f.png) ![Pasting Clipboard Image to Comments](https://cloud.githubusercontent.com/assets/39191/5794265/39c9b65a-9f1b-11e4-9bc7-04e41f59ea5f.png)
[*Read more about issue attachments.*](https://help.github.com/articles/issue-attachments) [*Read more about issue attachments.*](https://help.github.com/articles/issue-attachments/)
### Quick Licensing ### Quick Licensing
When creating a repository, GitHub gives you the option of adding in a pre-made license: When creating a repository, GitHub gives you the option of adding in a pre-made license:
@@ -414,7 +414,7 @@ You can also add them to existing repositories by creating a new file through th
Also works for `.gitignore`. Also works for `.gitignore`.
[*Read more about open source licensing.*](https://help.github.com/articles/open-source-licensing) [*Read more about open source licensing.*](https://help.github.com/articles/open-source-licensing/)
### Task Lists ### Task Lists
In Issues and Pull requests check boxes can be added with the following syntax (notice the space): In Issues and Pull requests check boxes can be added with the following syntax (notice the space):
@@ -441,7 +441,7 @@ When they are clicked, they will be updated in the pure Markdown:
- [ ] Sleep - [ ] Sleep
``` ```
[*Read more about task lists.*](https://help.github.com/articles/writing-on-github#task-lists) [*Read more about task lists.*](https://help.github.com/articles/writing-on-github/#task-lists)
#### Task Lists in Markdown Documents #### Task Lists in Markdown Documents
In full Markdown documents **read-only** checklists can now be added using the following syntax: In full Markdown documents **read-only** checklists can now be added using the following syntax:
@@ -476,7 +476,7 @@ Relative links are recommended in your Markdown files when linking to internal c
Absolute links have to be updated whenever the URL changes (e.g. repository renamed, username changed, project forked). Using relative links makes your documentation easily stand on its own. Absolute links have to be updated whenever the URL changes (e.g. repository renamed, username changed, project forked). Using relative links makes your documentation easily stand on its own.
[*Read more about relative links.*](https://help.github.com/articles/relative-links-in-readmes) [*Read more about relative links.*](https://help.github.com/articles/relative-links-in-readmes/)
### Metadata and Plugin Support for GitHub Pages ### Metadata and Plugin Support for GitHub Pages
Within Jekyll pages and posts, repository information is available within the `site.github` namespace, and can be displayed, for example, using `{{ site.github.project_title }}`. Within Jekyll pages and posts, repository information is available within the `site.github` namespace, and can be displayed, for example, using `{{ site.github.project_title }}`.
@@ -486,7 +486,7 @@ The Jemoji and jekyll-mentions plugins enable [emoji](#emojis) and [@mentions](h
[*Read more about repository metadata and plugin support for GitHub Pages.*](https://github.com/blog/1797-repository-metadata-and-plugin-support-for-github-pages) [*Read more about repository metadata and plugin support for GitHub Pages.*](https://github.com/blog/1797-repository-metadata-and-plugin-support-for-github-pages)
### Viewing YAML Metadata in your Documents ### Viewing YAML Metadata in your Documents
Many blogging websites, like [Jekyll](http://jekyllrb.com/) with [GitHub Pages](http://pages.github.com/), depend on some YAML-formatted metadata at the beginning of your post. GitHub will render this metadata as a horizontal table, for easier reading Many blogging websites, like [Jekyll](http://jekyllrb.com/) with [GitHub Pages](https://pages.github.com), depend on some YAML-formatted metadata at the beginning of your post. GitHub will render this metadata as a horizontal table, for easier reading
![YAML metadata](https://camo.githubusercontent.com/47245aa16728e242f74a9a324ce0d24c0b916075/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f36343035302f313232383236372f65303439643063362d323761302d313165332d396464382d6131636432323539393334342e706e67) ![YAML metadata](https://camo.githubusercontent.com/47245aa16728e242f74a9a324ce0d24c0b916075/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f36343035302f313232383236372f65303439643063362d323761302d313165332d396464382d6131636432323539393334342e706e67)
@@ -578,7 +578,7 @@ GitHub can display several common image formats, including PNG, JPG, GIF, and PS
[![Diffable PSD](https://cloud.githubusercontent.com/assets/2546/3165594/55f2798a-eb56-11e3-92e7-b79ad791a697.gif)](https://github.com/blog/1845-psd-viewing-diffing) [![Diffable PSD](https://cloud.githubusercontent.com/assets/2546/3165594/55f2798a-eb56-11e3-92e7-b79ad791a697.gif)](https://github.com/blog/1845-psd-viewing-diffing)
[*Read more about rendering and diffing images.*](https://help.github.com/articles/rendering-and-diffing-images) [*Read more about rendering and diffing images.*](https://help.github.com/articles/rendering-and-diffing-images/)
### Hub ### Hub
[Hub](https://github.com/github/hub) is a command line Git wrapper that gives you extra features and commands that make working with GitHub easier. [Hub](https://github.com/github/hub) is a command line Git wrapper that gives you extra features and commands that make working with GitHub easier.
@@ -749,7 +749,7 @@ git fetch origin
git checkout pr/42 git checkout pr/42
``` ```
[*Read more about checking out pull requests locally.*](https://help.github.com/articles/checking-out-pull-requests-locally) [*Read more about checking out pull requests locally.*](https://help.github.com/articles/checking-out-pull-requests-locally/)
### Empty Commits ### Empty Commits
Commits can be pushed with no code changes by adding `--allow-empty`: Commits can be pushed with no code changes by adding `--allow-empty`:
@@ -989,11 +989,10 @@ $ git config --global color.ui 1
| Official Git Tutorial | http://git-scm.com/docs/gittutorial | | Official Git Tutorial | http://git-scm.com/docs/gittutorial |
| Everyday Git | http://git-scm.com/docs/everyday | | Everyday Git | http://git-scm.com/docs/everyday |
| Git Immersion | http://gitimmersion.com/ | | Git Immersion | http://gitimmersion.com/ |
| Ry's Git Tutorial | http://rypress.com/tutorials/git/index.html | | Ry's Git Tutorial | http://rypress.com/tutorials/git/index |
| Git for Designers | http://hoth.entp.com/output/git_for_designers.html |
| Git for Computer Scientists | http://eagain.net/articles/git-for-computer-scientists/ | | Git for Computer Scientists | http://eagain.net/articles/git-for-computer-scientists/ |
| Git Magic | http://www-cs-students.stanford.edu/~blynn/gitmagic/ | | Git Magic | http://www-cs-students.stanford.edu/~blynn/gitmagic/ |
| GitHub Training Kit | http://training.github.com/kit | | GitHub Training Kit | https://training.github.com/kit/ |
| Git Visualization Playground | http://onlywei.github.io/explain-git-with-d3/#freeplay | | Git Visualization Playground | http://onlywei.github.io/explain-git-with-d3/#freeplay |
| Learn Git Branching | http://pcottle.github.io/learnGitBranching/ | | Learn Git Branching | http://pcottle.github.io/learnGitBranching/ |
| A collection of useful .gitignore templates | https://github.com/github/gitignore | | A collection of useful .gitignore templates | https://github.com/github/gitignore |
@@ -1001,13 +1000,13 @@ $ git config --global color.ui 1
#### Git Books #### Git Books
| Title | Link | | Title | Link |
| ----- | ---- | | ----- | ---- |
| Pragmatic Version Control Using Git | http://www.pragprog.com/titles/tsgit/pragmatic-version-control-using-git | | Pragmatic Version Control Using Git | https://pragprog.com/titles/tsgit/pragmatic-version-control-using-git |
| Pro Git | http://git-scm.com/book | | Pro Git | http://git-scm.com/book |
| Git Internals PluralSight | https://github.com/pluralsight/git-internals-pdf | | Git Internals PluralSight | https://github.com/pluralsight/git-internals-pdf |
| Git in the Trenches | http://cbx33.github.com/gitt/ | | Git in the Trenches | http://cbx33.github.io/gitt/ |
| Version Control with Git | http://www.amazon.com/Version-Control-Git-collaborative-development/dp/1449316387 | | 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 | | Pragmatic Guide to Git | https://pragprog.com/titles/pg_git/pragmatic-guide-to-git |
| Git: Version Control for Everyone | http://www.packtpub.com/git-version-control-for-everyone/book | | Git: Version Control for Everyone | https://www.packtpub.com/application-development/git-version-control-everyone |
#### Git Videos #### Git Videos
| Title | Link | | Title | Link |