/
index.html
143 lines (109 loc) · 5.61 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>GitHub Flavored Markdown - Introduction</title>
<link href="http://github.com/stylesheets/screen.css" media="screen" rel="stylesheet" type="text/css" />
<link href="/stylesheets/screen.css" media="screen" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="main">
<div id="header" class="basic">
<div class="site">
<div class="logo">
<a href="/"><img src="http://github.com/images/modules/header/logo_gfm.png" alt="github pages" /></a>
</div>
<div class="actions">
<a href="http://github.com">home</a>
<a href="http://github.com/login">login</a>
<a href="http://github.com/signup">signup!</a>
</div>
</div>
</div>
<div id="content" class="site">
<div class="wikistyle">
<h1>GitHub Flavored Markdown</h1>
<p>GitHub is transitioning to what we're calling "GitHub Flavored Markdown" (GFM) for messages, issues, and comments. It differs from standard Markdown (SM)
in a few significant ways and adds some additional functionality.</p>
<p>If you're not already familiar with Markdown, you should spend 15 minutes and go over the excellent <a href="http://daringfireball.net/projects/markdown/syntax">Markdown Syntax Guide</a> at Daring Fireball.</p>
<p>If you prefer to learn by example, see the following source and result:</p>
<ul>
<li><a href="sample_content.html">Source</a></li>
<li><a href="http://github.com/mojombo/github-flavored-markdown/issues/#issue/1">Result</a></li>
</ul>
<h2>Differences from traditional Markdown</h2>
<h3>Newlines</h3>
<p>The biggest difference that GFM introduces is in the handling of linebreaks. With SM you can hard wrap paragraphs of text and they will be combined into a single paragraph. We find this to be the cause of a huge number of unintentional formatting errors. GFM treats newlines in paragraph-like content as real line breaks, which is probably what you intended.</p>
<p>The next paragraph contains two phrases separated by a single newline character:</p>
<pre><code>Roses are red
Violets are blue
</code></pre>
<p>becomes</p>
<p>Roses are red<br/>
Violets are blue</p>
<h3>Multiple underscores in words</h3>
<p>It is not reasonable to italicize just <em>part</em> of a word, especially when you're dealing with code and names often appear with multiple underscores. Therefore, GFM ignores multiple underscores in words.</p>
<pre><code>perform_complicated_task
do_this_and_do_that_and_another_thing
</code></pre>
<p>becomes</p>
<p>perform_complicated_task<br/>
do_this_and_do_that_and_another_thing</p>
<h2>A bit of the GitHub spice</h2>
<p>In addition to the changes in the previous section, certain references are auto-linked:</p>
<pre><code>* SHA: be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
* User@SHA ref: mojombo@be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
* User/Project@SHA: mojombo/god@be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
* \#Num: #1
* User/#Num: mojombo#1
* User/Project#Num: mojombo/god#1
</code></pre>
<p>becomes</p>
<ul>
<li>SHA: <a href="/mojombo/github-flavored-markdown/commit/be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2">be6a8cc</a></li>
<li>User@SHA ref: <a href="/mojombo/github-flavored-markdown/commit/be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2">mojombo@be6a8cc</a></li>
<li>User/Project@SHA: <a href="/mojombo/god/commit/be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2">mojombo/god@be6a8cc</a></li>
<li>#Num: <a href="/mojombo/github-flavored-markdown/issues/#issue/1" class="internal">#1</a></li>
<li>User/#Num: <a href="/mojombo/github-flavored-markdown/issues/#issue/1">mojombo#1</a></li>
<li>User/Project#Num: <a href="/mojombo/god/issues/#issue/1">mojombo/god#1</a></li>
</ul>
</div>
</div>
<div class="push"></div>
</div>
<div id="footer">
<div class="site">
<div class="info">
<div class="links">
<a href="http://github.com/blog/148-github-shirts-now-available">T-Shirts</a> |
<a href="http://github.com/blog">Blog</a> |
<a href="http://support.github.com/">Support</a> |
<a href="http://github.com/training">Git Training</a> |
<a href="http://github.com/contact">Contact</a> |
<a href="http://groups.google.com/group/github/">Google Group</a> |
<a href="http://github.wordpress.com">Status</a>
</div>
<div class="company">
GitHub is <a href="http://logicalawesome.com/">Logical Awesome</a> ©2009 | <a href="http://github.com/site/terms">Terms of Service</a> | <a href="http://github.com/site/privacy">Privacy Policy</a>
</div>
</div>
<div class="sponsor">
<a href="http://engineyard.com"><img src="http://github.com/images/modules/footer/engine_yard_logo.png" alt="Engine Yard" /></a>
<div>
Hosting provided by our<br /> partners at Engine Yard
</div>
</div>
</div>
</div>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-3769691-2");
pageTracker._initData();
pageTracker._trackPageview();
</script>
</body>
</html>