Markdown Syntax Reference

This reference is by no means complete. It serves as a lookup source for my own use and therefore contains only the elements of markdown syntax that I use most regularly. A more comprehensive reference of the markdown syntax can be found at the daringfireball markdown project home.

View the sample document:

plain text (revealing markdown syntax) | markdown converted to html


Headings:

# Heading Level 1

## Heading Level 2

--- 

Paragraphs: 

paragraphs can
span multiple lines.
to start a new paragraph:

use one or more empty lines.

---

Emphasis:

**bold**

*italics*

---

Lists:


- Item 1
- Item 2 - with a para

  some text

- Item 3
 - Subitem 1
 - Subitem 2

An ordered list:

1. ordered list item 1
2. item 2
- you only need to put the first '1.' then each subsequent item can be as in an unordered list
- item 4

---

Images:

![RubyGreenBlue logo](/images/powered_by_bars.png "logo")

reference style:

![RubyGreenBlue logo][logo]

[logo]: /images/powered_by_bars.png "logo"

---

Code:

Inline `code` reference

indent 4 spaces for whole blocks of code:


    def initialize
      SvnBlog::Base.username = 'secret'
      SvnBlog::Base.password = 'secret'
      SvnBlog::Base.articles_require :published => true
      @blog = SvnBlog::Base.new("#{RAILS_ROOT}/public/blog")
      configure_main_menu
      configure_sub_menu
    end


---

Links:

a link to [RubyGreenBlue](http://rubygreenblue.com)

Reference style:

[RubyGreenBlue][rgb]

[rgb]: http://rubygreenblue.com

---

Quoting:

> some block quoted text
>> some block quoted text


---

Horizontal line:

---

plain text (revealing markdown syntax) | markdown converted to html