Markdown Guide

Markdown is a very simple and lightweight markup language. Anywhere on the confoundry that you see a textarea (a text input that allows multiple lines of text) markdown is supported. Many times there will be a preview button to allow you to see how a page will look once it has been rendered in markdown. This page is actually written in markdown, and you can view its raw source if you'd like to see an example.

Syntax

The syntax for markdown is designed to be very readable and intuitive. It only uses punctuation.

Paragraphs

Markdown cares a lot about paragraphs. This may be confusing at first, but it multiple lines of text with only one linebreak between them will be joined together as a single paragraph. When you want to start a new pargraph, you must leave a blank line:

first paragraph pastrami turducken, ground round flank t-bone strip steak
tail venison jerky.

second paragraph ham tail, prosciutto shankle andouille salami shank
pastrami swine biltong corned beef.

Inline formatting

Markdown offers a few ways to format text inline with a paragraph. For the time being images and links will only work in personal messages to other users.

  • Emphasized Text: *Emphasized Text*
  • Strong Text: **Strong Text**
  • Link: [Link](http://google.com)
  • http://google.com/: <http://google.com>
  • Image Alt Text ![Image Alt Text](/static/image/grubble_small.png)

When you would like to use one of these characters without their formatting effects, you can escape them with a \ or put them in a code block

Headers

You can produce headers by preceding a line with a # (pound) symbol. The number of #'s determines the level of the header.

# h1
## h2
### h3
#### h4

Similarly, you can user a line of = or - symbols below the line of text:

This would turn into a level 1 header
=====================================

This would turn into a level 2 header
-------------------------------------

Lists

Ordered lists

1. first item
2. second item
3. third item

Produces:

  1. first item
  2. second item
  3. third item

Unordered lists

- item
- item
- item
  • item
  • item
  • item

Code Blocks

There are two ways to insert code --- inline and block.

Inline code is delimited by backticks: `code`. Block code is indicated be preceding every line with at least four spaces:

    code block
    code block

Compiles to

code block
code block

You should use a code block whenever formatting or special characters should be preserved.

Quoting

To quote someone, you should precede each line with a >:

Pork belly bacon leberkase chuck t-bone cow, andouille tenderloin pork shank. Tenderloin tri-tip capicola, turkey hamburger boudin kielbasa pork belly beef. Boudin pork chop rump, bresaola swine meatloaf tongue jowl leberkase pork belly turkey. Ham turkey capicola, strip steak brisket short loin shoulder sausage ground round fatback tenderloin chuck meatloaf. Salami drumstick pork chop, turducken sausage hamburger t-bone pork belly ground round meatloaf ribeye andouille shoulder. Ribeye ball tip short loin meatloaf, turducken boudin kielbasa pork chop drumstick pork pork belly bresaola corned beef filet mignon.

Frankfurter filet mignon prosciutto, bresaola tongue corned beef tri-tip. Beef cow boudin, shoulder hamburger kielbasa ground round ball tip tenderloin. Turkey andouille kielbasa strip steak filet mignon. Meatloaf capicola short loin hamburger pancetta ribeye. Swine pig chuck, venison pastrami hamburger bacon short ribs.