Edit File by line

<!doctype html>

[0] Fix | Delete

[1] Fix | Delete

<title>CodeMirror: Markdown mode</title>

[2] Fix | Delete

[3] Fix | Delete

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

[9] Fix | Delete

[10] Fix | Delete

[11] Fix | Delete

.CodeMirror {border-top: 1px solid black; border-bottom: 1px solid black;}

[12] Fix | Delete

.cm-s-default .cm-trailing-space-a:before,

[13] Fix | Delete

.cm-s-default .cm-trailing-space-b:before {position: absolute; content: "\00B7"; color: #777;}

[14] Fix | Delete

.cm-s-default .cm-trailing-space-new-line:before {position: absolute; content: "\21B5"; color: #777;}

[15] Fix | Delete

</style>

[16] Fix | Delete

[17] Fix | Delete

<a href="http://codemirror.net"><h1>CodeMirror</h1><img id=logo src="../../doc/logo.png"></a>

[18] Fix | Delete

[19] Fix | Delete

<ul>

[20] Fix | Delete

[21] Fix | Delete

<li><a href="../../doc/manual.html">Manual</a>

[22] Fix | Delete

[23] Fix | Delete

</ul>

[24] Fix | Delete

<ul>

[25] Fix | Delete

<li><a href="../index.html">Language modes</a>

[26] Fix | Delete

<li><a class=active href="#">Markdown</a>

[27] Fix | Delete

</ul>

[28] Fix | Delete

</div>

[29] Fix | Delete

[30] Fix | Delete

[31] Fix | Delete

<h2>Markdown mode</h2>

[32] Fix | Delete

[33] Fix | Delete

Markdown: Basics

[34] Fix | Delete

================

[35] Fix | Delete

[36] Fix | Delete

[37] Fix | Delete

[38] Fix | Delete

<li><a class="selected" title="Markdown Basics">Basics</a></li>

[39] Fix | Delete

<li><a href="/projects/markdown/syntax" title="Markdown Syntax Documentation">Syntax</a></li>

[40] Fix | Delete

<li><a href="/projects/markdown/license" title="Pricing and License Information">License</a></li>

[41] Fix | Delete

<li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li>

[42] Fix | Delete

</ul>

[43] Fix | Delete

[44] Fix | Delete

[45] Fix | Delete

Getting the Gist of Markdown's Formatting Syntax

[46] Fix | Delete

------------------------------------------------

[47] Fix | Delete

[48] Fix | Delete

This page offers a brief overview of what it's like to use Markdown.

[49] Fix | Delete

The [syntax page] [s] provides complete, detailed documentation for

[50] Fix | Delete

every feature, but Markdown should be very easy to pick up simply by

[51] Fix | Delete

looking at a few examples of it in action. The examples on this page

[52] Fix | Delete

are written in a before/after style, showing example syntax and the

[53] Fix | Delete

HTML output produced by Markdown.

[54] Fix | Delete

[55] Fix | Delete

It's also helpful to simply try Markdown out; the [Dingus] [d] is a

[56] Fix | Delete

web application that allows you type your own Markdown-formatted text

[57] Fix | Delete

and translate it to XHTML.

[58] Fix | Delete

[59] Fix | Delete

**Note:** This document is itself written using Markdown; you

[60] Fix | Delete

can [see the source for it by adding '.text' to the URL] [src].

[61] Fix | Delete

[62] Fix | Delete

[s]: /projects/markdown/syntax "Markdown Syntax"

[63] Fix | Delete

[d]: /projects/markdown/dingus "Markdown Dingus"

[64] Fix | Delete

[src]: /projects/markdown/basics.text

[65] Fix | Delete

[66] Fix | Delete

[67] Fix | Delete

## Paragraphs, Headers, Blockquotes ##

[68] Fix | Delete

[69] Fix | Delete

A paragraph is simply one or more consecutive lines of text, separated

[70] Fix | Delete

by one or more blank lines. (A blank line is any line that looks like

[71] Fix | Delete

a blank line -- a line containing nothing but spaces or tabs is

[72] Fix | Delete

considered blank.) Normal paragraphs should not be indented with

[73] Fix | Delete

spaces or tabs.

[74] Fix | Delete

[75] Fix | Delete

Markdown offers two styles of headers: *Setext* and *atx*.

[76] Fix | Delete

Setext-style headers for `<h1>` and `<h2>` are created by

[77] Fix | Delete

"underlining" with equal signs (`=`) and hyphens (`-`), respectively.

[78] Fix | Delete

To create an atx-style header, you put 1-6 hash marks (`#`) at the

[79] Fix | Delete

beginning of the line -- the number of hashes equals the resulting

[80] Fix | Delete

HTML header level.

[81] Fix | Delete

[82] Fix | Delete

Blockquotes are indicated using email-style '`>`' angle brackets.

[83] Fix | Delete

[84] Fix | Delete

Markdown:

[85] Fix | Delete

[86] Fix | Delete

A First Level Header

[87] Fix | Delete

====================

[88] Fix | Delete

[89] Fix | Delete

A Second Level Header

[90] Fix | Delete

---------------------

[91] Fix | Delete

[92] Fix | Delete

Now is the time for all good men to come to

[93] Fix | Delete

the aid of their country. This is just a

[94] Fix | Delete

regular paragraph.

[95] Fix | Delete

[96] Fix | Delete

The quick brown fox jumped over the lazy

[97] Fix | Delete

dog's back.

[98] Fix | Delete

[99] Fix | Delete

### Header 3

[100] Fix | Delete

[101] Fix | Delete

> This is a blockquote.

[102] Fix | Delete

[103] Fix | Delete

> This is the second paragraph in the blockquote.

[104] Fix | Delete

[105] Fix | Delete

> ## This is an H2 in a blockquote

[106] Fix | Delete

[107] Fix | Delete

[108] Fix | Delete

Output:

[109] Fix | Delete

[110] Fix | Delete

<h1>A First Level Header</h1>

[111] Fix | Delete

[112] Fix | Delete

<h2>A Second Level Header</h2>

[113] Fix | Delete

[114] Fix | Delete

<p>Now is the time for all good men to come to

[115] Fix | Delete

the aid of their country. This is just a

[116] Fix | Delete

regular paragraph.</p>

[117] Fix | Delete

[118] Fix | Delete

<p>The quick brown fox jumped over the lazy

[119] Fix | Delete

dog's back.</p>

[120] Fix | Delete

[121] Fix | Delete

<h3>Header 3</h3>

[122] Fix | Delete

[123] Fix | Delete

[124] Fix | Delete

<p>This is a blockquote.</p>

[125] Fix | Delete

[126] Fix | Delete

<p>This is the second paragraph in the blockquote.</p>

[127] Fix | Delete

[128] Fix | Delete

<h2>This is an H2 in a blockquote</h2>

[129] Fix | Delete

</blockquote>

[130] Fix | Delete

[131] Fix | Delete

[132] Fix | Delete

[133] Fix | Delete

### Phrase Emphasis ###

[134] Fix | Delete

[135] Fix | Delete

Markdown uses asterisks and underscores to indicate spans of emphasis.

[136] Fix | Delete

[137] Fix | Delete

Markdown:

[138] Fix | Delete

[139] Fix | Delete

Some of these words *are emphasized*.

[140] Fix | Delete

Some of these words _are emphasized also_.

[141] Fix | Delete

[142] Fix | Delete

Use two asterisks for **strong emphasis**.

[143] Fix | Delete

Or, if you prefer, __use two underscores instead__.

[144] Fix | Delete

[145] Fix | Delete

Output:

[146] Fix | Delete

[147] Fix | Delete

<p>Some of these words <em>are emphasized</em>.

[148] Fix | Delete

Some of these words <em>are emphasized also</em>.</p>

[149] Fix | Delete

[150] Fix | Delete

<p>Use two asterisks for <strong>strong emphasis</strong>.

[151] Fix | Delete

Or, if you prefer, <strong>use two underscores instead</strong>.</p>

[152] Fix | Delete

[153] Fix | Delete

[154] Fix | Delete

[155] Fix | Delete

## Lists ##

[156] Fix | Delete

[157] Fix | Delete

Unordered (bulleted) lists use asterisks, pluses, and hyphens (`*`,

[158] Fix | Delete

`+`, and `-`) as list markers. These three markers are

[159] Fix | Delete

interchangable; this:

[160] Fix | Delete

[161] Fix | Delete

* Candy.

[162] Fix | Delete

* Gum.

[163] Fix | Delete

* Booze.

[164] Fix | Delete

[165] Fix | Delete

this:

[166] Fix | Delete

[167] Fix | Delete

+ Candy.

[168] Fix | Delete

+ Gum.

[169] Fix | Delete

+ Booze.

[170] Fix | Delete

[171] Fix | Delete

and this:

[172] Fix | Delete

[173] Fix | Delete

- Candy.

[174] Fix | Delete

- Gum.

[175] Fix | Delete

- Booze.

[176] Fix | Delete

[177] Fix | Delete

all produce the same output:

[178] Fix | Delete

[179] Fix | Delete

<ul>

[180] Fix | Delete

<li>Candy.</li>

[181] Fix | Delete

[182] Fix | Delete

<li>Booze.</li>

[183] Fix | Delete

</ul>

[184] Fix | Delete

[185] Fix | Delete

Ordered (numbered) lists use regular numbers, followed by periods, as

[186] Fix | Delete

list markers:

[187] Fix | Delete

[188] Fix | Delete

1. Red

[189] Fix | Delete

2. Green

[190] Fix | Delete

3. Blue

[191] Fix | Delete

[192] Fix | Delete

Output:

[193] Fix | Delete

[194] Fix | Delete

<ol>

[195] Fix | Delete

[196] Fix | Delete

<li>Green</li>

[197] Fix | Delete

[198] Fix | Delete

</ol>

[199] Fix | Delete

[200] Fix | Delete

If you put blank lines between items, you'll get `<p>` tags for the

[201] Fix | Delete

list item text. You can create multi-paragraph list items by indenting

[202] Fix | Delete

the paragraphs by 4 spaces or 1 tab:

[203] Fix | Delete

[204] Fix | Delete

* A list item.

[205] Fix | Delete

[206] Fix | Delete

With multiple paragraphs.

[207] Fix | Delete

[208] Fix | Delete

* Another item in the list.

[209] Fix | Delete

[210] Fix | Delete

Output:

[211] Fix | Delete

[212] Fix | Delete

<ul>

[213] Fix | Delete

[214] Fix | Delete

<p>With multiple paragraphs.</p></li>

[215] Fix | Delete

<li><p>Another item in the list.</p></li>

[216] Fix | Delete

</ul>

[217] Fix | Delete

[218] Fix | Delete

[219] Fix | Delete

[220] Fix | Delete

### Links ###

[221] Fix | Delete

[222] Fix | Delete

Markdown supports two styles for creating links: *inline* and

[223] Fix | Delete

*reference*. With both styles, you use square brackets to delimit the

[224] Fix | Delete

text you want to turn into a link.

[225] Fix | Delete

[226] Fix | Delete

Inline-style links use parentheses immediately after the link text.

[227] Fix | Delete

For example:

[228] Fix | Delete

[229] Fix | Delete

This is an [example link](http://example.com/).

[230] Fix | Delete

[231] Fix | Delete

Output:

[232] Fix | Delete

[233] Fix | Delete

[234] Fix | Delete

example link</a>.</p>

[235] Fix | Delete

[236] Fix | Delete

Optionally, you may include a title attribute in the parentheses:

[237] Fix | Delete

[238] Fix | Delete

This is an [example link](http://example.com/ "With a Title").

[239] Fix | Delete

[240] Fix | Delete

Output:

[241] Fix | Delete

[242] Fix | Delete

[243] Fix | Delete

example link</a>.</p>

[244] Fix | Delete

[245] Fix | Delete

Reference-style links allow you to refer to your links by names, which

[246] Fix | Delete

you define elsewhere in your document:

[247] Fix | Delete

[248] Fix | Delete

I get 10 times more traffic from [Google][1] than from

[249] Fix | Delete

[Yahoo][2] or [MSN][3].

[250] Fix | Delete

[251] Fix | Delete

[1]: http://google.com/ "Google"

[252] Fix | Delete

[2]: http://search.yahoo.com/ "Yahoo Search"

[253] Fix | Delete

[3]: http://search.msn.com/ "MSN Search"

[254] Fix | Delete

[255] Fix | Delete

Output:

[256] Fix | Delete

[257] Fix | Delete

<p>I get 10 times more traffic from <a href="http://google.com/"

[258] Fix | Delete

title="Google">Google</a> than from <a href="http://search.yahoo.com/"

[259] Fix | Delete

title="Yahoo Search">Yahoo</a> or <a href="http://search.msn.com/"

[260] Fix | Delete

title="MSN Search">MSN</a>.</p>

[261] Fix | Delete

[262] Fix | Delete

The title attribute is optional. Link names may contain letters,

[263] Fix | Delete

numbers and spaces, but are *not* case sensitive:

[264] Fix | Delete

[265] Fix | Delete

I start my morning with a cup of coffee and

[266] Fix | Delete

[The New York Times][NY Times].

[267] Fix | Delete

[268] Fix | Delete

[ny times]: http://www.nytimes.com/

[269] Fix | Delete

[270] Fix | Delete

Output:

[271] Fix | Delete

[272] Fix | Delete

<p>I start my morning with a cup of coffee and

[273] Fix | Delete

<a href="http://www.nytimes.com/">The New York Times</a>.</p>

[274] Fix | Delete

[275] Fix | Delete

[276] Fix | Delete

### Images ###

[277] Fix | Delete

[278] Fix | Delete

Image syntax is very much like link syntax.

[279] Fix | Delete

[280] Fix | Delete

Inline (titles are optional):

[281] Fix | Delete

[282] Fix | Delete

![alt text](/path/to/img.jpg "Title")

[283] Fix | Delete

[284] Fix | Delete

Reference-style:

[285] Fix | Delete

[286] Fix | Delete

![alt text][id]

[287] Fix | Delete

[288] Fix | Delete

[id]: /path/to/img.jpg "Title"

[289] Fix | Delete

[290] Fix | Delete

Both of the above examples produce the same output:

[291] Fix | Delete

[292] Fix | Delete

[293] Fix | Delete

[294] Fix | Delete

[295] Fix | Delete

[296] Fix | Delete

### Code ###

[297] Fix | Delete

[298] Fix | Delete

In a regular paragraph, you can create code span by wrapping text in

[299] Fix | Delete

backtick quotes. Any ampersands (`&`) and angle brackets (`<` or

[300] Fix | Delete

`>`) will automatically be translated into HTML entities. This makes

[301] Fix | Delete

it easy to use Markdown to write about HTML example code:

[302] Fix | Delete

[303] Fix | Delete

I strongly recommend against using any `<blink>` tags.

[304] Fix | Delete

[305] Fix | Delete

I wish SmartyPants used named entities like `&mdash;`

[306] Fix | Delete

instead of decimal-encoded entites like `&#8212;`.

[307] Fix | Delete

[308] Fix | Delete

Output:

[309] Fix | Delete

[310] Fix | Delete

<p>I strongly recommend against using any

[311] Fix | Delete

<code>&lt;blink&gt;</code> tags.</p>

[312] Fix | Delete

[313] Fix | Delete

<p>I wish SmartyPants used named entities like

[314] Fix | Delete

<code>&amp;mdash;</code> instead of decimal-encoded

[315] Fix | Delete

entites like <code>&amp;#8212;</code>.</p>

[316] Fix | Delete

[317] Fix | Delete

[318] Fix | Delete

To specify an entire block of pre-formatted code, indent every line of

[319] Fix | Delete

the block by 4 spaces or 1 tab. Just like with code spans, `&`, `<`,

[320] Fix | Delete

and `>` characters will be escaped automatically.

[321] Fix | Delete

[322] Fix | Delete

Markdown:

[323] Fix | Delete

[324] Fix | Delete

If you want your page to validate under XHTML 1.0 Strict,

[325] Fix | Delete

you've got to put paragraph tags in your blockquotes:

[326] Fix | Delete

[327] Fix | Delete

[328] Fix | Delete

<p>For example.</p>

[329] Fix | Delete

</blockquote>

[330] Fix | Delete

[331] Fix | Delete

Output:

[332] Fix | Delete

[333] Fix | Delete

<p>If you want your page to validate under XHTML 1.0 Strict,

[334] Fix | Delete

you've got to put paragraph tags in your blockquotes:</p>

[335] Fix | Delete

[336] Fix | Delete

<pre><code>&lt;blockquote&gt;

[337] Fix | Delete

&lt;p&gt;For example.&lt;/p&gt;

[338] Fix | Delete

&lt;/blockquote&gt;

[339] Fix | Delete

</code></pre>

[340] Fix | Delete

</textarea></form>

[341] Fix | Delete

[342] Fix | Delete

[343] Fix | Delete

var editor = CodeMirror.fromTextArea(document.getElementById("code"), {

[344] Fix | Delete

mode: 'markdown',

[345] Fix | Delete

lineNumbers: true,

[346] Fix | Delete

theme: "default",

[347] Fix | Delete

extraKeys: {"Enter": "newlineAndIndentContinueMarkdownList"}

[348] Fix | Delete

});

[349] Fix | Delete

</script>

[350] Fix | Delete

[351] Fix | Delete

<p>You might want to use the <a href="../gfm/index.html">Github-Flavored Markdown mode</a> instead, which adds support for fenced code blocks and a few other things.</p>

[352] Fix | Delete

[353] Fix | Delete

<p>Optionally depends on the XML mode for properly highlighted inline XML blocks.</p>

[354] Fix | Delete

[355] Fix | Delete

<p><strong>MIME types defined:</strong> <code>text/x-markdown</code>.</p>

[356] Fix | Delete

[357] Fix | Delete

<p><strong>Parsing/Highlighting Tests:</strong> <a href="../../test/index.html#markdown_*">normal</a>, <a href="../../test/index.html#verbose,markdown_*">verbose</a>.</p>

[358] Fix | Delete

[359] Fix | Delete

</article>

[360] Fix | Delete

[361] Fix | Delete