diff --git a/markdown.html.markdown b/markdown.html.markdown index b956a5f2..f17c2b75 100644 --- a/markdown.html.markdown +++ b/markdown.html.markdown @@ -2,45 +2,53 @@ language: markdown contributors: - ["Dan Turkel", "http://danturkel.com/"] + - ["Jacob Ward", "http://github.com/JacobCWard/"] filename: markdown.md --- + Markdown was created by John Gruber in 2004. It's meant to be an easy to read and write syntax which converts easily to HTML (and now many other formats as well). -Give me as much feedback as you want! / Feel free to fork and pull request! - - -```markdown - +element's contents. - +specific to a certain parser. - - +- [Headings](#headings) +- [Simple Text Styles](#simple-text-styles) + +## Headings + +You can create HTML elements `
` element) by indenting
+a line with four spaces or a tab.
+
+```markdown
This is code
So is this
+```
-
+You can also re-tab (or add an additional four spaces) for indentation
+inside your code
+```markdown
my_array.each do |item|
puts item
end
+```
-
+Inline code can be created using the backtick character `
+```markdown
John didn't even know what the `go_to()` function did!
+```
-
-
+In Github Flavored Markdown, you can use a special syntax for code
+```markdown
\`\`\`ruby
def foobar
puts "Hello world!"
end
\`\`\`
+```
-
+The above text doesn't require indenting, plus Github will use syntax
+highlighting of the language you specify after the \`\`\`
-
-
+## Horizontal rule (`
`)
+Horizontal rules are easily added with three or more asterisks or hyphens,
+with or without spaces.
+```markdown
***
---
- - -
****************
+```
-
-
+## Links
+One of the best things about markdown is how easy it is to make links. Put
+the text to display in hard brackets [] followed by the url in parentheses ()
+
+```markdown
[Click me!](http://test.com/)
-
-
-
+```
+You can also add a link title using quotes inside the parentheses.
+```markdown
[Click me!](http://test.com/ "Link to Test.com")
-
-
-
+```
+Relative paths work too.
+```markdown
[Go to music](/music/).
-
-
-
+```
+Markdown also supports reference style links.
+```markdown
[Click this link][link1] for more info about it!
[Also check out this link][foobar] if you want to.
[link1]: http://test.com/ "Cool!"
[foobar]: http://foobar.biz/ "Alright!"
-
-
-
-
+There is also "implicit naming" which lets you use the link text as the id.
+```markdown
[This][] is a link.
[this]: http://thisisalink.com/
+```
+But it's not that commonly used.
-
-
-
-
-
+## Images
+Images are done the same way as links but with an exclamation point in front!
+```markdown
![This is the alt-attribute for my image](http://imgur.com/myimage.jpg "An optional title")
-
-
-
+```
+And reference style works as expected.
+```markdown
![This is the alt-attribute.][myimage]
[myimage]: relative/urls/cool/image.jpg "if you need a title, it's here"
+```
-
-
-
+## Miscellany
+### Auto-links
+```markdown
is equivalent to
[http://testwebsite.com/](http://testwebsite.com/)
+```
-
-
+### Auto-links for emails
+```markdown
+```
-
-
+### Escaping characters
+```markdown
I want to type *this text surrounded by asterisks* but I don't want it to be
in italics, so I do this: \*this text surrounded by asterisks\*.
+```
-
-
+### Keyboard keys
+In Github Flavored Markdown, you can use a tag to represent keyboard keys.
+```markdown
Your computer crashed? Try sending a
Ctrl+Alt+Del
+```
+### Tables
-
-
-
+Tables are only available in Github Flavored Markdown and are slightly
+cumbersome, but if you really want it:
+```markdown
| Col1 | Col2 | Col3 |
| :----------- | :------: | ------------: |
| Left-aligned | Centered | Right-aligned |
| blah | blah | blah |
+```
+or, for the same results
-
-
+```markdown
Col 1 | Col2 | Col3
:-- | :-: | --:
Ugh this is so ugly | make it | stop
-
-
-
```
-
+---
For more info, check out John Gruber's official post of syntax [here](http://daringfireball.net/projects/markdown/syntax) and Adam Pritchard's great cheatsheet [here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).