aleph1.co.uk Git - yaffs-website/blob - vendor/cebe/markdown/tests/github-data/github-sample.md

   1 GitHub Flavored Markdown
   2 ================================
   3
   4 *View the [source of this content](http://github.github.com/github-flavored-markdown/sample_content.html).*
   5
   6 Let's get the whole "linebreak" thing out of the way. The next paragraph contains two phrases separated by a single newline character:
   7
   8 Roses are red
   9 Violets are blue
  10
  11 The next paragraph has the same phrases, but now they are separated by two spaces and a newline character:
  12
  13 Roses are red
  14 Violets are blue
  15
  16 Oh, and one thing I cannot stand is the mangling of words with multiple underscores in them like perform_complicated_task or do_this_and_do_that_and_another_thing.
  17
  18 A bit of the GitHub spice
  19 -------------------------
  20
  21 In addition to the changes in the previous section, certain references are auto-linked:
  22
  23 * SHA: be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
  24 * User@SHA ref: mojombo@be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
  25 * User/Project@SHA: mojombo/god@be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
  26 * \#Num: #1
  27 * User/#Num: mojombo#1
  28 * User/Project#Num: mojombo/god#1
  29
  30 These are dangerous goodies though, and we need to make sure email addresses don't get mangled:
  31
  32 My email addy is tom@github.com.
  33
  34 Math is hard, let's go shopping
  35 -------------------------------
  36
  37 In first grade I learned that 5 > 3 and 2 < 7. Maybe some arrows. 1 -> 2 -> 3. 9 <- 8 <- 7.
  38
  39 Triangles man! a^2 + b^2 = c^2
  40
  41 We all like making lists
  42 ------------------------
  43
  44 The above header should be an H2 tag. Now, for a list of fruits:
  45
  46 * Red Apples
  47 * Purple Grapes
  48 * Green Kiwifruits
  49
  50 Let's get crazy:
  51
  52 1.  This is a list item with two paragraphs. Lorem ipsum dolor
  53     sit amet, consectetuer adipiscing elit. Aliquam hendrerit
  54     mi posuere lectus.
  55
  56     Vestibulum enim wisi, viverra nec, fringilla in, laoreet
  57     vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
  58     sit amet velit.
  59
  60 2.  Suspendisse id sem consectetuer libero luctus adipiscing.
  61
  62 What about some code **in** a list? That's insane, right?
  63
  64 1. In Ruby you can map like this:
  65
  66         ['a', 'b'].map { |x| x.uppercase }
  67
  68 2. In Rails, you can do a shortcut:
  69
  70         ['a', 'b'].map(&:uppercase)
  71
  72 Some people seem to like definition lists
  73
  74 <dl>
  75   <dt>Lower cost</dt>
  76   <dd>The new version of this product costs significantly less than the previous one!</dd>
  77   <dt>Easier to use</dt>
  78   <dd>We've changed the product so that it's much easier to use!</dd>
  79 </dl>
  80
  81 I am a robot
  82 ------------
  83
  84 Maybe you want to print `robot` to the console 1000 times. Why not?
  85
  86     def robot_invasion
  87       puts("robot " * 1000)
  88     end
  89
  90 You see, that was formatted as code because it's been indented by four spaces.
  91
  92 How about we throw some angle braces and ampersands in there?
  93
  94     <div class="footer">
  95         &copy; 2004 Foo Corporation
  96     </div>
  97
  98 Set in stone
  99 ------------
 100
 101 Preformatted blocks are useful for ASCII art:
 102
 103 <pre>
 104              ,-.
 105     ,     ,-.   ,-.
 106    / \   (   )-(   )
 107    \ |  ,.>-(   )-<
 108     \|,' (   )-(   )
 109      Y ___`-'   `-'
 110      |/__/   `-'
 111      |
 112      |
 113      |    -hrr-
 114   ___|_____________
 115 </pre>
 116
 117 Playing the blame game
 118 ----------------------
 119
 120 If you need to blame someone, the best way to do so is by quoting them:
 121
 122 > I, at any rate, am convinced that He does not throw dice.
 123
 124 Or perhaps someone a little less eloquent:
 125
 126 > I wish you'd have given me this written question ahead of time so I
 127 > could plan for it... I'm sure something will pop into my head here in
 128 > the midst of this press conference, with all the pressure of trying to
 129 > come up with answer, but it hadn't yet...
 130 >
 131 > I don't want to sound like
 132 > I have made no mistakes. I'm confident I have. I just haven't - you
 133 > just put me under the spot here, and maybe I'm not as quick on my feet
 134 > as I should be in coming up with one.
 135
 136 Table for two
 137 -------------
 138
 139 <table>
 140   <tr>
 141     <th>ID</th><th>Name</th><th>Rank</th>
 142   </tr>
 143   <tr>
 144     <td>1</td><td>Tom Preston-Werner</td><td>Awesome</td>
 145   </tr>
 146   <tr>
 147     <td>2</td><td>Albert Einstein</td><td>Nearly as awesome</td>
 148   </tr>
 149 </table>
 150
 151 Crazy linking action
 152 --------------------
 153
 154 I get 10 times more traffic from [Google] [1] than from
 155 [Yahoo] [2] or [MSN] [3].
 156
 157   [1]: http://google.com/        "Google"
 158   [2]: http://search.yahoo.com/  "Yahoo Search"
 159   [3]: http://search.msn.com/    "MSN Search"