Skip to content

Instantly share code, notes, and snippets.

@joyrexus
Created March 12, 2013 22:03
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save joyrexus/5147504 to your computer and use it in GitHub Desktop.
Save joyrexus/5147504 to your computer and use it in GitHub Desktop.
A quick overview of Markdown.

Markdown

In which we list tips, tricks, and reminders.

Official documentation:

Style

italic

*italic*   

bold

**bold**

italic

_italic_   

bold

__bold__

Inline

[Inline](http://url.com/ "Inline example")

[Reference-style][id] with labels (titles are optional). [id]: http://example.com/ "Reference-style example"

[Reference-style][id] with labels (titles are optional).
[id]: http://example.com/  "Reference-style example"

Images

Inline (titles are optional):

![alt text](/path/img.jpg "Title")

Reference-style:

![alt text][id]

[id]: /url/to/img.jpg "Title"

Headers

Setext-style:

Header 1
========

Header 2
--------

atx-style (closing #'s are optional):

# Header 1 #

## Header 2 ##

###### Header 6

Lists

Ordered, without paragraphs:

1.  Foo
2.  Bar

Unordered, with paragraphs:

*   A list item.

    With multiple paragraphs.

*   Bar

You can nest them:

*   Abacus
    * answer
*   Bubbles
    1.  bunk
    2.  bupkis
        * BELITTLER
    3. burper
*   Cunning

Blockquotes

> Email-style angle brackets
> are used for blockquotes.

> > And, they can be nested.

> #### Headers in blockquotes
> 
> * You can quote a list.
> * Etc.

Code Spans

`<code>` spans are delimited
by backticks.

You can include literal backticks
like `` `this` ``.

Code Blocks

Indent every line of a code block by at least 4 spaces or 1 tab.

This is a normal paragraph.

    This is a preformatted
    code block.

Code Fences

Use three backticks to fence code blocks for better syntax-highlighting support, but note that this is a Github GFM convention.

```coffeescript
hi = (name) ->
    print "hello #{name}!"

    hi __filename
```

Horizontal Rules

Three or more dashes or asterisks:

---

* * *

- - - - 

Manual Line Breaks

End a line with two or more spaces:

Roses are red,   
Violets are blue.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment