Skip to content

Instantly share code, notes, and snippets.

@lieldulev
Created June 1, 2012 03:48
Show Gist options
  • Save lieldulev/2848574 to your computer and use it in GitHub Desktop.
Save lieldulev/2848574 to your computer and use it in GitHub Desktop.
Markdown syntax explained in one file

Markdown Syntax


Is easy to learn and simple to implement

Leave empty line for a new paragraph.

Consecutive lines of text will continue by default, and they will be wrapped for you so you don't need to worry about it (unlike code). If you want to force a line break
just finish a line with double space
and you will have a
new
line in the same paragraph


##Lists

###Bullets

  • A List
  • Indented
  • All three markers are bullets
    and can have multiple lines

###Numbers

  1. Numbered list start with a digit followed by period.
  2. Numbers (before period) are not important
  3. You can
  4. Repeat the
  5. Same number

Code

Inline

To write code inline use `

Blocks

# just use 4 spaces
# and don't forget
code()
{
   identation++
}

be_careful_of_very_long_lines_they_might_break_github_since_it_wont_break_them_for_you I am serius. You need to break them yourself 

Links

This is an example.

This link has no title attribute.

This is an example for in document link.

You can define links in advance and give them names.

And then use them.

Or just use simple "automatic" links: http://example.com/


Inline HTML

<tr style="background-color:lightgrey">
    <td>with inline</td>
    <td>css (yuck!)</td>
</tr>
This is an HTML TABLE

This is another regular paragraph.


Images

Simple syntax:

Alt text

And ou can use all the tricks from links ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment