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

Improve syntax highlighting section

Browse Source
This commit is contained in:
Rafal Chmiel
2014-04-13 11:34:20 +01:00
parent 7676a6afe5
commit 05c97b48d6
1 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -95,11 +95,18 @@ If you want to link to another issue in the same repo, simple type hash `#` then
To link to an issue in another repo, `user_name/repo_name#ISSUE_NUMBER` e.g. `tiimgreen/toc#12`.
## Syntax Highlighting in README
## Syntax Highlighting in Markdown Files
To add syntax highlighting to code in README:
For example, to syntax highlight Ruby code in your Markdown files write:
![Syntax Highlighting](http://i.imgur.com/ZRgjcWt.png)
```ruby
require 'tabbit'
table = Tabbit.new('Name', 'Email')
table.add_row('Tim Green', 'tiimgreen@gmail.com')
puts table.to_s
```
This will produce:
```ruby
require 'tabbit'
@@ -108,6 +115,8 @@ table.add_row('Tim Green', 'tiimgreen@gmail.com')
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).
## Commit History by Author
To view all commits on a repo by author add `?author=username` to the URL.