Garrett Flavored Markdown Reference Guide


The Markdown reference on this page is composed of content from the original Markdown site as well as the GitHub site.
You will find GitHub-Flavored-Markdown and Garrett-Flavored-Markdown variants highlighted within the document.

Markdown: Syntax

Note: This document is itself written using Markdown; you can see the source for it by looking at the source in GitHub.



Markdown is intended to be as easy-to-read and easy-to-write as is feasible.

Readability, however, is emphasized above all else. A Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions. While Markdown's syntax has been influenced by several existing text-to-HTML filters -- including Setext, atx, Textile, reStructuredText, Grutatext, and EtText -- the single biggest source of inspiration for Markdown's syntax is the format of plain text email.

To this end, Markdown's syntax is comprised entirely of punctuation characters, which punctuation characters have been carefully chosen so as to look like what they mean. E.g., asterisks around a word actually look like *emphasis*. Markdown lists look like, well, lists. Even blockquotes look like quoted passages of text, assuming you've ever used email.

Inline HTML

Markdown's syntax is intended for one purpose: to be used as a format for writing for the web.

Markdown is not a replacement for HTML, or even close to it. Its syntax is very small, corresponding only to a very small subset of HTML tags. The idea is not to create a syntax that makes it easier to insert HTML tags. In my opinion, HTML tags are already easy to insert. The idea for Markdown is to make it easy to read, write, and edit prose. HTML is a publishing format; Markdown is a writing format. Thus, Markdown's formatting syntax only addresses issues that can be conveyed in plain text.

For any markup that is not covered by Markdown's syntax, you simply use HTML itself. There's no need to preface it or delimit it to indicate that you're switching from Markdown to HTML; you just use the tags.

The only restrictions are that block-level HTML elements -- e.g. <div>, <table>, <pre>, <p>, etc. -- must be separated from surrounding
content by blank lines, and the start and end tags of the block should not be indented with tabs or spaces. Markdown is smart enough not to add extra (unwanted) <p> tags around HTML block-level tags.

For example, to add an HTML table to a Markdown article:

This is a regular paragraph.

    <tr>  <td>Foo</td></tr>

This is another regular paragraph. 

Note that Markdown formatting syntax is not processed within block-level HTML tags. E.g., you can't use Markdown-style *emphasis* inside an HTML block.

Span-level HTML tags -- e.g. <span>, <cite>, or <del> -- can be used anywhere in a Markdown paragraph, list item, or header. If you want, you can even use HTML tags instead of Markdown formatting; e.g. if you'd prefer to use HTML <a> or <img> tags instead of Markdown's link or image syntax, go right ahead.

Unlike block-level HTML tags, Markdown syntax is processed within span-level tags.

Automatic Escaping for Special Characters

In HTML, there are two characters that demand special treatment: < and &. Left angle brackets are used to start tags; ampersands are used to denote HTML entities. If you want to use them as literal characters, you must escape them as entities, e.g. &lt;, and &amp;.

Ampersands in particular are bedeviling for web writers. If you want to write about 'AT&T', you need to write 'AT&amp;T'. You even need to escape ampersands within URLs. Thus, if you want to link to: 

you need to encode the URL as:;q=larry+bird 

in your anchor tag href attribute. Needless to say, this is easy to forget, and is probably the single most common source of HTML validation errors in otherwise well-marked-up web sites.

Markdown allows you to use these characters naturally, taking care of all the necessary escaping for you. If you use an ampersand as part of an HTML entity, it remains unchanged; otherwise it will be translated into &amp;.

So, if you want to include a copyright symbol in your article, you can write:


and Markdown will leave it alone. But if you write:


Markdown will translate it to:


Similarly, because Markdown supports inline HTML, if you use angle brackets as delimiters for HTML tags, Markdown will treat them as such. But if you write:

4 < 5 

Markdown will translate it to:

4 &lt; 5 

However, inside Markdown code spans and blocks, angle brackets and ampersands are always encoded automatically. This makes it easy to use Markdown to write about HTML code. (As opposed to raw HTML, which is a terrible format for writing about HTML syntax, because every single < and & in your example code needs to be escaped.)


New with Garrett-Flavored-Markdown

Support for automatic tables has been added. Can't get any simpler than this!

To create a table, just use the | character to starting at the left margin, and use the | again to seperate columns and at the end of a row.

The first row is always the header.

For example:


will render out as:


Block Elements

Paragraphs and Line Breaks

A paragraph is simply one or more consecutive lines of text, separated by one or more blank lines. (A blank line is any line that looks like a blank line -- a line containing nothing but spaces or tabs is considered blank.) Normal paragraphs should not be indented with spaces or tabs.

New with Github-Flavored-Markdown

The biggest difference that GFM introduces is in the handling of linebreaks. With regular markdown you can hard wrap paragraphs of text and they will be combined into a single paragraph. We find this to be the cause of a huge number of unintentional formatting errors. GFM treats newlines in paragraph-like content as real line breaks, which is probably what you intended.

The next paragraph contains two phrases separated by a single newline character:

Roses are red
Violets are blue


Roses are red
Violets are blue

Markdown supports two styles of headers, Setext and atx.

Setext-style headers are "underlined" using equal signs (for first-level
headers) and dashes (for second-level headers). For example:

This is an H1

This is an H2

Any number of underlining ='s or -'s will work.

Atx-style headers use 1-6 hash characters at the start of the line,
corresponding to header levels 1-6. For example:

# This is an H1

## This is an H2

###### This is an H6 

Optionally, you may "close" atx-style headers. This is purely cosmetic -- you can use this if you think it looks better. The closing hashes don't even need to match the number of hashes used to open the header. (The number of opening hashes determines the header level.) :

# This is an H1 #

## This is an H2 ##

### This is an H3 ###### 


Markdown uses email-style > characters for blockquoting. If you're familiar with quoting passages of text in an email message, then you
know how to create a blockquote in Markdown. It looks best if you hard wrap the text and put a > before every line:

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing. 

Markdown allows you to be lazy and only put the > before the first line of a hard-wrapped paragraph:

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing. 

Blockquotes can be nested (i.e. a blockquote-in-a-blockquote) by adding additional levels of >:

> This is the first level of quoting.
> > This is nested blockquote.
> Back to the first level. 

Blockquotes can contain other Markdown elements, including headers, lists, and code blocks:

> ## This is a header.
> 1.   This is the first list item.
> 2.   This is the second list item.
> Here's some example code:
>     return shell_exec("echo $input | $markdown_script"); 

Any decent text editor should make email-style quoting easy. For example, with BBEdit, you can make a selection and choose Increase Quote Level from the Text menu.


Markdown supports ordered (numbered) and unordered (bulleted) lists.

Unordered lists use asterisks, pluses, and hyphens -- interchangably -- as list markers:

*   Red
*   Green
*   Blue 

is equivalent to:

+   Red
+   Green
+   Blue 


-   Red
-   Green
-   Blue 

Ordered lists use numbers followed by periods:

1.  Bird
2.  McHale
3.  Parish 

It's important to note that the actual numbers you use to mark the list have no effect on the HTML output Markdown produces. The HTML Markdown produces from the above list is:


If you instead wrote the list in Markdown like this:

1.  Bird
1.  McHale
1.  Parish 

or even:

3. Bird
1. McHale
8. Parish 

you'd get the exact same HTML output. The point is, if you want to, you can use ordinal numbers in your ordered Markdown lists, so that the numbers in your source match the numbers in your published HTML. But if you want to be lazy, you don't have to.

If you do use lazy list numbering, however, you should still start the list with the number 1. At some point in the future, Markdown may support starting ordered lists at an arbitrary number.

List markers typically start at the left margin, but may be indented by up to three spaces. List markers must be followed by one or more spaces or a tab.

To make lists look nice, you can wrap items with hanging indents:

*   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
    Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
    viverra nec, fringilla in, laoreet vitae, risus.
*   Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
    Suspendisse id sem consectetuer libero luctus adipiscing. 

But if you want to be lazy, you don't have to:

*   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
viverra nec, fringilla in, laoreet vitae, risus.
*   Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
Suspendisse id sem consectetuer libero luctus adipiscing. 

If list items are separated by blank lines, Markdown will wrap the items in <p> tags in the HTML output. For example, this input:

*   Bird
*   Magic 

will turn into:


But this:

*   Bird

*   Magic 

will turn into:


List items may consist of multiple paragraphs. Each subsequent paragraph in a list item must be indented by either 4 spaces or one tab:

1.  This is a list item with two paragraphs. Lorem ipsum dolor
    sit amet, consectetuer adipiscing elit. Aliquam hendrerit
    mi posuere lectus.

    Vestibulum enim wisi, viverra nec, fringilla in, laoreet
    vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
    sit amet velit.

2.  Suspendisse id sem consectetuer libero luctus adipiscing. 

It looks nice if you indent every line of the subsequent paragraphs, but here again, Markdown will allow you to be lazy:

*   This is a list item with two paragraphs.

    This is the second paragraph in the list item. You're
only required to indent the first line. Lorem ipsum dolor
sit amet, consectetuer adipiscing elit.

*   Another item in the same list. 

To put a blockquote within a list item, the blockquote's > delimiters need to be indented:

*   A list item with a blockquote:

    > This is a blockquote
    > inside a list item. 

To put a code block within a list item, the code block needs to be indented twice -- 8 spaces or two tabs:

*   A list item with a code block:

        <code goes here> 

It's worth noting that it's possible to trigger an ordered list by accident, by writing something like this:

1986. What a great season. 

In other words, a number-period-space sequence at the beginning of a line. To avoid this, you can backslash-escape the period:

1986\. What a great season. 

Code Blocks

Pre-formatted code blocks are used for writing about programming or markup source code. Rather than forming normal paragraphs, the lines of a code block are interpreted literally. Markdown wraps a code block in both <pre> and <code> tags.

To produce a code block in Markdown, simply indent every line of the block by at least 4 spaces or 1 tab. For example, given this input:

This is a normal paragraph:

    This is a code block. 

Markdown will generate:

<p>This is a normal paragraph:</p>

<pre><code>This is a code block.

One level of indentation -- 4 spaces or 1 tab -- is removed from each line of the code block. For example, this:

Here is an example of AppleScript:

    tell application "Foo"
    end tell 

will turn into:

<p>Here is an example of AppleScript:</p>

<pre><code>tell application "Foo"
end tell

A code block continues until it reaches a line that is not indented (or the end of the article).

Within a code block, ampersands (&) and angle brackets (< and >) are automatically converted into HTML entities. This makes it very easy to include example HTML source code using Markdown -- just paste it and indent it, and Markdown will handle the hassle of encoding the ampersands and angle brackets. For example, this:

    <div class="footer">
        &copy; 2004 Foo Corporation

will turn into:

<pre><code>&lt;div class="footer"&gt;
    &amp;copy; 2004 Foo Corporation

Regular Markdown syntax is not processed within code blocks. E.g., asterisks are just literal asterisks within a code block. This means it's also easy to use Markdown to write about Markdown's own syntax.

New with Github-Flavored-Markdown

Fenced Code Blocks Markdown converts text with four spaces at the front of each line to code blocks. GFM supports that, but we also support fenced blocks. Just wrap your code blocks in ``` and you won't need to indent manually to trigger a code block.

New with Garrett-Flavored-Markdown

Syntax highlighting We take code blocks a step further and add syntax highlighting if you request it. In your fenced block, add an optional language identifier and we'll run it through syntax highlighting. For example, to syntax highlight Ruby code:

``` ruby
require 'redcarpet'
markdown ="Hello World!")
puts markdown.to_html

will use an online pygments-powered syntax-highlighter to generate pretty-formatted html for your sourcecode:

require 'redcarpet'
markdown ="Hello World!")
puts markdown.to_html

Syntax-highlighter Languages

The following is a list of the more common languages that are supported.

Toggle full language list
Languagehighlight codeLanguagehighlight code
IRC logsircJavajava
MakefilemakeMakefile (basemake)basemake
PythonpythonPython 3python3
Python 3.0 Tracebackpy3tbPython console sessionpycon
Python TracebackpytbRaw token dataraw
RubyrbRuby irb sessionrbcon
SQLsqlText onlytext
Languagehighlight codeLanguagehighlight code
ActionScript 3as3Adaada
ANTLRantlrANTLR With ActionScript Targetantlr-as
ANTLR With C# Targetantlr-csharpANTLR With CPP Targetantlr-cpp
ANTLR With Java Targetantlr-javaANTLR With ObjectiveC Targetantlr-objc
ANTLR With Perl Targetantlr-perlANTLR With Python Targetantlr-python
ANTLR With Ruby Targetantlr-rubyApacheConfapacheconf
BashbashBash Sessionconsole
Coldufsion HTMLcfmCommon Lispcommon-lisp
CSS+Django/Jinjacss+djangoCSS+Genshi Textcss+genshitext
Darcs PatchdpatchDebian Control filecontrol
Debian SourcelistsourceslistDelphidelphi
DylandylanEmbedded Ragelragel-em
Erlang erl sessionerlEvoqueevoque
Genshi TextgenshitextGettext Catalogpot
IoioIRC logsirc
JavajavaJava Server Pagejsp
JavaScript+Django/Jinjajs+djangoJavaScript+Genshi Textjs+genshitext
JavaScript+Smartyjs+smartyLighttpd configuration filelighty
Literate HaskelllhsLLVMllvm
MakefilemakeMakefile (basemake)basemake
Modula-2modula2MoinMoin/Trac Wiki markuptrac-wiki
NewspeaknewspeakNginx configuration filenginx
PythonpythonPython 3python3
Python 3.0 Tracebackpy3tbPython console sessionpycon
Python TracebackpytbRaw token dataraw
Ruby irb sessionrbconSsplus
TeXtexText onlytext

New with Garrett-Flavored-Markdown

Smuggling links into syntax-highlighted regions
It's possible to do some meta-formatting with the content in the syntax-highlighted blocks if you want to put a link around a peice of text. Note: This is a big-hack, and it's pretty certain there are conditions where this won't work and will spew hashes around your code.

Reformat the code you want to have a link in with the following:


The « character can be typed using ALT-174 on the numpad.
The » character can be typed using ALT-175 on the numpad.

Replace the ORIGINAL-BIT-OF_CODE with the code in the block.
Replace the LINK with the link target.

For an example, see ptk page source

New with Github-Flavored-Markdown

A bit of the GitHub spice
In addition to the changes in the previous section, certain references are auto-linked : note: these work when there is a project context. Probably broken right now.

* SHA: be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
* User@SHA ref: mojombo@be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
* User/Project@SHA: mojombo/god@be6a8cc
* \#Num: #1
* User/#Num: mojombo#1
* User/Project#Num: mojombo/god#1 


  • SHA: be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
  • User@SHA ref: mojombo@be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
  • User/Project@SHA: mojombo/god@be6a8cc
  • #Num: #1
  • User/#Num: mojombo#1
  • User/Project#Num: mojombo/god#1

Horizontal Rules

You can produce a horizontal rule tag (<hr />) by placing three or more hyphens, asterisks, or underscores on a line by themselves. If you wish, you may use spaces between the hyphens or asterisks. Each of the following lines will produce a horizontal rule:

* * *



- - -


Span Elements


Markdown supports two style of links: inline and reference.

In both styles, the link text is delimited by [square brackets].

To create an inline link, use a set of regular parentheses immediately after the link text's closing square bracket. Inside the parentheses, put the URL where you want the link to point, along with an optional title for the link, surrounded in quotes. For example:

This is [an example]( "Title") inline link.

[This link]( has no title attribute. 

Will produce:

<p>This is <a href="" title="Title">
an example</a> inline link.</p>

<p><a href="">This link</a> has no
title attribute.</p> 

If you're referring to a local resource on the same server, you can use relative paths:

See my [About](/about/) page for details.    

Reference-style links use a second set of square brackets, inside which you place a label of your choosing to identify the link:

This is [an example][id] reference-style link. 

You can optionally use a space to separate the sets of brackets:

This is [an example] [id] reference-style link. 

Then, anywhere in the document, you define your link label like this,
on a line by itself:

[id]:  "Optional Title Here" 

That is:

  • Square brackets containing the link identifier (optionally indented from the left margin using up to three spaces);
  • followed by a colon;
  • followed by one or more spaces (or tabs);
  • followed by the URL for the link;
  • optionally followed by a title attribute for the link, enclosed in double or single quotes, or enclosed in parentheses.

The following three link definitions are equivalent:

[foo]:  "Optional Title Here"
[foo]:  'Optional Title Here'
[foo]:  (Optional Title Here) 

Note: There is a known bug in 1.0.1 which prevents single quotes from being used to delimit link titles.

The link URL may, optionally, be surrounded by angle brackets:

[id]: <>;  "Optional Title Here" 

You can put the title attribute on the next line and use extra spaces or tabs for padding, which tends to look better with longer URLs:

    "Optional Title Here" 

Link definitions are only used for creating links during Markdown processing, and are stripped from your document in the HTML output.

Link definition names may consist of letters, numbers, spaces, and punctuation -- but they are not case sensitive. E.g. these two links:

[link text][a]
[link text][A] 

are equivalent.

The implicit link name shortcut allows you to omit the name of the link, in which case the link text itself is used as the name. Just use an empty set of square brackets -- e.g., to link the word "Google" to the web site, you could simply write:


And then define the link:


Because link names may contain spaces, this shortcut even works formultiple words in the link text:

Visit [Daring Fireball][] for more information. 

And then define the link:

[Daring Fireball]: 

Link definitions can be placed anywhere in your Markdown document. Itend to put them immediately after each paragraph in which they'reused, but if you want, you can put them all at the end of yourdocument, sort of like footnotes.

Here's an example of reference links in action:

I get 10 times more traffic from [Google] [1] than from
[Yahoo] [2] or [MSN] [3].

  [1]:        "Google"
  [2]:  "Yahoo Search"
  [3]:    "MSN Search" 

Using the implicit link name shortcut, you could instead write:

I get 10 times more traffic from [Google][] than from
[Yahoo][] or [MSN][].

  [google]:        "Google"
  [yahoo]:  "Yahoo Search"
  [msn]:    "MSN Search" 

Both of the above examples will produce the following HTML output:

<p>I get 10 times more traffic from <a href=""
title="Google">Google</a> than from
<a href="" title="Yahoo Search">Yahoo</a>
or <a href="" title="MSN Search">MSN</a>.</p> 

For comparison, here is the same paragraph written usingMarkdown's inline link style:

I get 10 times more traffic from [Google]( "Google")
than from [Yahoo]( "Yahoo Search") or
[MSN]( "MSN Search"). 

The point of reference-style links is not that they're easier towrite. The point is that with reference-style links, your documentsource is vastly more readable. Compare the above examples: usingreference-style links, the paragraph itself is only 81 characterslong; with inline-style links, it's 176 characters; and as raw HTML,it's 234 characters. In the raw HTML, there's more markup than thereis text.

With Markdown's reference-style links, a source document much moreclosely resembles the final output, as rendered in a browser. Byallowing you to move the markup-related metadata out of the paragraph,you can add links without interrupting the narrative flow of yourprose.

New with Garrett-Flavored-Markdown

Inter-document References Pages in the site can declare a `docid` in their YAML Front Matter. The docid can be used as a reference from any other page in the website, making it less likely that pages will break links if moved around.

For example, this page has the header:

layout: 'article'
title: 'Garrett Flavored Markdown Reference Guide' 
version: '1.0'
docid: 'gfm'

And other documents in this site can reference it by simply:

Check out the [garrett-flavored-markdown][gfm] page. 

which renders as:

Check out the garrett-flavored-markdown page.

Referece Anchors
If you want to declare an anchor on a page (so that you can have a link jump to it with #anchorname) you can create one with the following syntax:

[anchor text](!anchorname) 

which registers an sitewide reference as docid#anchorname which means you can even use anchors within the page to jump to a particular location in another document:

Check out this [links section][gfm#link] . 

which renders as:

Check out this links section .


Markdown treats asterisks (*) and underscores (_) as indicators ofemphasis. Text wrapped with one * or _ will be wrapped with anHTML <em> tag; double *'s or _'s will be wrapped with an HTML<strong> tag. E.g., this input:

*single asterisks*

_single underscores_

**double asterisks**

__double underscores__ 

will produce:

<em>single asterisks</em>

<em>single underscores</em>

<strong>double asterisks</strong>

<strong>double underscores</strong> 

You can use whichever style you prefer; the lone restriction is that the same character must be used to open and close an emphasis span.

Emphasis can be used in the middle of a word:


But if you surround an * or _ with spaces, it'll be treated as a literal asterisk or underscore.

To produce a literal asterisk or underscore at a position where it would otherwise be used as an emphasis delimiter, you can backslash escape it:

\*this text is surrounded by literal asterisks\* 

New with Github-Flavored-Markdown

Multiple underscores in words
It is not reasonable to italicize just part of a word, especially when you're dealing with code and names often appear with multiple underscores. Therefore, GFM ignores multiple underscores in words.





To indicate a span of code, wrap it with backtick quotes (`).Unlike a pre-formatted code block, a code span indicates code within anormal paragraph. For example:

Use the `printf()` function. 

will produce:

<p>Use the <code>printf()</code> function.</p> 

To include a literal backtick character within a code span, you can usemultiple backticks as the opening and closing delimiters:

``There is a literal backtick (`) here.`` 

which will produce this:

<p><code>There is a literal backtick (`) here.</code></p> 

The backtick delimiters surrounding a code span may include spaces --one after the opening, one before the closing. This allows you to placeliteral backtick characters at the beginning or end of a code span:

A single backtick in a code span: `` ` ``

A backtick-delimited string in a code span: `` `foo` `` 

will produce:

<p>A single backtick in a code span: <code>`</code></p>

<p>A backtick-delimited string in a code span: <code>`foo`</code></p> 

With a code span, ampersands and angle brackets are encoded as HTMLentities automatically, which makes it easy to include example HTMLtags. Markdown will turn this:

Please don't use any `<blink>` tags. 


<p>Please don't use any <code>&lt;blink&gt;</code> tags.</p> 

You can write this:

`&#8212;` is the decimal-encoded equivalent of `&mdash;`. 

to produce:

<p><code>&amp;#8212;</code> is the decimal-encoded
equivalent of <code>&amp;mdash;</code>.</p> 


Admittedly, it's fairly difficult to devise a "natural" syntax forplacing images into a plain text document format.

Markdown uses an image syntax that is intended to resemble the syntaxfor links, allowing for two styles: inline and reference.

Inline image syntax looks like this:

![Alt text](/path/to/img.jpg)

![Alt text](/path/to/img.jpg "Optional title") 

That is:

  • An exclamation mark: !;
  • followed by a set of square brackets, containing the alt attribute text for the image;
  • followed by a set of parentheses, containing the URL or path to the image, and an optional title attribute enclosed in double or single quotes.

Reference-style image syntax looks like this:

![Alt text][id] 

Where "id" is the name of a defined image reference. Image referencesare defined using syntax identical to link references:

[id]: url/to/image  "Optional title attribute" 

As of this writing, Markdown has no syntax for specifying thedimensions of an image; if this is important to you, you can simplyuse regular HTML <img> tags.

New with Garrett-Flavored-Markdown

Image location references You can just give the filename to the image itself in an image reference. DocPad will find the image in the static content and generate the full path for you.

![Alt text][foo.jpg]  

Will find an image named foo.jpg somewhere in the /static/ folder tree and place the full path to the image in the link for you.

New with Garrett-Flavored-Markdown

Scrollable Image Wrapper GFM also has the ability to wrap an image in an overflow-sensitive wrapper so that it won't wreck your layout.

Substitute an at-symbol @ for the exclamation ! in the image syntax:

@[Alt text](imageurl) 

And you will get a nicely contained image rendering.

New with Garrett-Flavored-Markdown

Really Smart Video Embedding GFM has made embedding videos into the pages trivial, wrapping up the functionality from MediaElement.js so that videos can be posted supporting all browsers (including phones) by only encoding two formats (h.264 and webm) and the video will render as HTML5 video links, or fall back to Flash or Silverlight for embedding.

The format for embedding videos is:



width - the desired width of the video (actually, not used anymore, the video container scales to the size of it's parent layout)
height - the desired height of the video (actually, not used anymore, the video container scales to the size of it's parent layout)
posterimageurl - the image url for the poster (when it's not playing) -- this can just be the filename, and will look up in the /static/ folder automatically.
mp4url - the full url to the mp4 video WARNING do not put the video file in GitHub, we need to upload them to our Azure CDN to make sure that bandwith and size are managed correctly (contact Garrett :).
webmurl - the full url to the webm video WARNING do not put the video file in GitHub, we need to upload them to our Azure CDN to make sure that bandwith and size are managed correctly (contact Garrett :).

For information on transcoding video files to .mp4 and .webm, check out this tutorial


Markdown supports a shortcut style for creating "automatic" links for URLs and email addresses: simply surround the URL or email address with angle brackets. What this means is that if you want to show the actual text of a URL or email address, and also have it be a clickable link, you can do this:


Markdown will turn this into:

<a href=""></a>; 

Automatic links for email addresses work similarly, except thatMarkdown will also perform a bit of randomized decimal and hexentity-encoding to help obscure your address from address-harvestingspambots. For example, Markdown will turn this:


into something like this:

<a href="&#x6D;&#x61;i&#x6C;&#x74;&#x6F;:&#x61;&#x64;&#x64;&#x72;&#x65;

which will render in a browser as a clickable link to "".

(This sort of entity-encoding trick will indeed fool many, if notmost, address-harvesting bots, but it definitely won't fool all ofthem. It's better than nothing, but an address published in this waywill probably eventually start receiving spam.)

New with Github-Flavored-Markdown

URL autolinking
GFM will autolink standard URLs, so if you want to link to a URL (instead of setting link text), you can simply enter the URL and it will be turned into a link to that URL.

Backslash Escapes

Markdown allows you to use backslash escapes to generate literalcharacters which would otherwise have special meaning in Markdown'sformatting syntax. For example, if you wanted to surround a wordwith literal asterisks (instead of an HTML <em> tag), you can usebackslashes before the asterisks, like this:

\*literal asterisks\* 

Markdown provides backslash escapes for the following characters:

\   backslash
`   backtick
*   asterisk
_   underscore
{}  curly braces
[]  square brackets
()  parentheses
#   hash mark
+    plus sign
-    minus sign (hyphen)
.   dot
!   exclamation mark