Skip to content

Instantly share code, notes, and snippets.

@bshaffer
Created January 20, 2012 18:23
Show Gist options
  • Save bshaffer/1648811 to your computer and use it in GitHub Desktop.
Save bshaffer/1648811 to your computer and use it in GitHub Desktop.
Introducing Markdown for Developer Connection Content and Comments

Have you ever pasted application code into a forum thread and saved it, only to see your comment broken and garbled when you refresh the page? This may have happened to you, and as developers it is imperative that our code samples are properly formatted.

Markdown is a lightweight markup language that corrects this frustration. It is easy to read and easy to write, ensuring your content is formatted properly. For those not familiar, spend some time going over the official Markdown Syntax Guide at Daring Fireball. If you are the Learn-By-Doing type, check out the Web Dingus. As an example, we will demonstrate the main syntactical elements used by most developers, which are bold, italics, links, lists, and code blocks.

I _really_ like that [Developer Connection](http://developer.omniture.com) supports `Markdown`.  I can now post rich code like this!

    $response = $api->sendRequest('Company.GetReportSuites', $params);
    return $response['report_suites'];

Thanks, **guys**, for making this possible.  On the whole, I'd say you all are:

* Benevolent
* Tenacious
* Splendid

This will output the following response:


I really like that Developer Connection supports Markdown. I can now post rich code like this!

$response = $api->sendRequest('Company.GetReportSuites', $params);
return $response['report_suites'];

Thanks, guys, for making this possible. On the whole, I'd say you all are:

  • Benevolent
  • Tenacious
  • Splendid

There is a convenient reference to the syntax guide everywhere Markdown is used. Look for the link in the upper right corner of the text area.

Clicking on it will provide you with a fancybox containing the syntax guide.

For those familiar with Github-Flavored Markdown (GFM), there are some key differences. The most important one being newline breaks are not parsed as <br /> tags. Add two or more spaces at the end of a line to insert a line break.

Thank you for contributing to Developer Connection! We hope to make your ongoing participation as enjoyable as possible. Also, we would love to hear from you. Please comment below (using Markdown!) with your thoughts on the change.

This blog post has been written in Markdown. View the source.

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