Available Syntax

Here's a list of current syntax options. Notations are provided for PHP Extras syntax, Maruku syntax, GFM, and NAMP dialects. For most of these, you'll want to also check out the HTML source to see what's going on.

PHRASE EMPHASIS

italic bold
italic bold

LINKS

Inline: An example

Reference-style labels (titles are optional): An example. Then, anywhere
else in the doc, define the link:

IMAGES

Inline (titles are optional):

Reference-style:

HEADERS

Header 1

Header 2

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

Header 1

Header 2

Header 6

LISTS

Ordered, without paragraphs:

1. Eggs
2. Milk
3. Cheese
4. Anything

Ordered, with paragraphs:

1. Eggs

   Preferrably brown

2. Milk

   Wait, I am lactose intolerant

3. Cheese
4. Wait, Cheese?

Unordered, with paragraphs:

• A list item.

  With multiple paragraphs.

• Bar

You can nest them:

• Abacus
  • A tool
• Banana
  1. Fruit
  2. Gorilla snack
     • (or, for monkeys)
  3. Yellow
• Camel

BLOCKQUOTES

Email-style angle brackets are used for blockquotes.

And, they can be nested.

Headers in blockquotes

• You can quote a list.
• Like this.
  1. And nest one.

CODE SPANS

<code> spans are delimited by backticks.

You can include literal backticks like `this` .

PREFORMATTED 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 blocks can also be "fenced" by ``` (GitHub-Flavored-Markdown)

console.log("flock yeah!");

For extra awesome, add the name of a programming language to the first fence, in order to syntax highlight it.

var x = function () { 
  console.log("This actually has 'perl' as a tag!")
};

(Highlighting is enabled by default; you'll have to define your own CSS that matches the highlight-js notation, though, which this document does not do!)

STRIKETHROUGH

Hey, this is terrible great!

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.

PUNCTUATION

"check it out" "

\"

"should not curl"

"Wow"

TABLES (PHP Extras)

|a |b |c |:---|---|--- |1 |2 |3

|a |b |c |:--|:--:|:-- |1 |2 (or two) |[3]{: .threeClass} |4 |5 | 6 {: #demo test="true"}

x |y |z --|--|-- 8 |9 |10 {: .table .table-striped .table-bordered .table-condensed}

Demonstrating alignment:

right|left | center

:|:-----|:------: 0001 | 2 (or two) | 003 4 | 0005 | 6

DEFINITION LISTS (PHP Extras)

(sadly, broken)

Apple : Pomaceous fruit of plants of the genus Malus in the family Rosaceae.

• List in dl
• Another item
  • Wait, one more !
    {: .listStyle} : Okay, back to another dd.

Orange : The fruit of an evergreen tree of the genus Citrus.

print "Testing yet again"

It's extremly hard to come up with make believe text.

Pomegranate : A deciduous shrub or small tree (Punica granatum), native to Asia and widely cultivated for its edible fruit. Anyway, Blah blah blah.adsadsasd.

Term 1 : This is a definition with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. : Second definition for term 1, also wrapped in a paragraph

because of the blank line preceding it. {: .test}   

{: #TestingIDHere}

ATTRIBUTES (Maruku)

{: #myid .myclass}

Look around{: .class1} you! View [the source code!]{: .someclass .someclass2 vague="no"} This whole area is covered in attributes! {: #bigBlock tutorial=yes}

Spans should be covered in [ ], with the attribute list defined afterwards.

AUTO-LINK

http://foo.com/

ENCODING

& < "aaa" &

Twitter Bootstrap tags

These classes have to do with Twitter Bootstrap stylings for Note: , Tip: , and Warning: .

INLINE HTML

HTML should be represented as is.
The quick brown fox jumps over the lazy dog.

Keybindings

To have fun, press: ˄-⌥-Down. Or, you know, don't.

⌘-X

Your Name, Setup, Develop, Stuff

Menus

Click Your Name > Setup > Develop > Stuff. For Visualforce components, click Blah > Setup > Develop > Components.