| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344 | <!doctype html><html>  <head>    <meta charset="utf-8">    <title>CodeMirror: Markdown mode</title>    <link rel="stylesheet" href="../../lib/codemirror.css">    <script src="../../lib/codemirror.js"></script>    <script src="../../addon/edit/continuelist.js"></script>    <script src="../xml/xml.js"></script>    <script src="markdown.js"></script>    <style type="text/css">.CodeMirror {border-top: 1px solid black; border-bottom: 1px solid black;}</style>    <link rel="stylesheet" href="../../doc/docs.css">  </head>  <body>    <h1>CodeMirror: Markdown mode</h1><!-- source: http://daringfireball.net/projects/markdown/basics.text --><form><textarea id="code" name="code">Markdown: Basics================<ul id="ProjectSubmenu">    <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li>    <li><a class="selected" title="Markdown Basics">Basics</a></li>    <li><a href="/projects/markdown/syntax" title="Markdown Syntax Documentation">Syntax</a></li>    <li><a href="/projects/markdown/license" title="Pricing and License Information">License</a></li>    <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li></ul>Getting the Gist of Markdown's Formatting Syntax------------------------------------------------This page offers a brief overview of what it's like to use Markdown.The [syntax page] [s] provides complete, detailed documentation forevery feature, but Markdown should be very easy to pick up simply bylooking at a few examples of it in action. The examples on this pageare written in a before/after style, showing example syntax and theHTML output produced by Markdown.It's also helpful to simply try Markdown out; the [Dingus] [d] is aweb application that allows you type your own Markdown-formatted textand translate it to XHTML.**Note:** This document is itself written using Markdown; youcan [see the source for it by adding '.text' to the URL] [src].  [s]: /projects/markdown/syntax  "Markdown Syntax"  [d]: /projects/markdown/dingus  "Markdown Dingus"  [src]: /projects/markdown/basics.text## Paragraphs, Headers, Blockquotes ##A paragraph is simply one or more consecutive lines of text, separatedby one or more blank lines. (A blank line is any line that looks likea blank line -- a line containing nothing but spaces or tabs isconsidered blank.) Normal paragraphs should not be indented withspaces or tabs.Markdown offers two styles of headers: *Setext* and *atx*.Setext-style headers for `<h1>` and `<h2>` are created by"underlining" with equal signs (`=`) and hyphens (`-`), respectively.To create an atx-style header, you put 1-6 hash marks (`#`) at thebeginning of the line -- the number of hashes equals the resultingHTML header level.Blockquotes are indicated using email-style '`>`' angle brackets.Markdown:    A First Level Header    ====================        A Second Level Header    ---------------------    Now is the time for all good men to come to    the aid of their country. This is just a    regular paragraph.    The quick brown fox jumped over the lazy    dog's back.        ### Header 3    > This is a blockquote.    >     > This is the second paragraph in the blockquote.    >    > ## This is an H2 in a blockquoteOutput:    <h1>A First Level Header</h1>        <h2>A Second Level Header</h2>        <p>Now is the time for all good men to come to    the aid of their country. This is just a    regular paragraph.</p>        <p>The quick brown fox jumped over the lazy    dog's back.</p>        <h3>Header 3</h3>        <blockquote>        <p>This is a blockquote.</p>                <p>This is the second paragraph in the blockquote.</p>                <h2>This is an H2 in a blockquote</h2>    </blockquote>### Phrase Emphasis ###Markdown uses asterisks and underscores to indicate spans of emphasis.Markdown:    Some of these words *are emphasized*.    Some of these words _are emphasized also_.        Use two asterisks for **strong emphasis**.    Or, if you prefer, __use two underscores instead__.Output:    <p>Some of these words <em>are emphasized</em>.    Some of these words <em>are emphasized also</em>.</p>        <p>Use two asterisks for <strong>strong emphasis</strong>.    Or, if you prefer, <strong>use two underscores instead</strong>.</p>   ## Lists ##Unordered (bulleted) lists use asterisks, pluses, and hyphens (`*`,`+`, and `-`) as list markers. These three markers areinterchangable; this:    *   Candy.    *   Gum.    *   Booze.this:    +   Candy.    +   Gum.    +   Booze.and this:    -   Candy.    -   Gum.    -   Booze.all produce the same output:    <ul>    <li>Candy.</li>    <li>Gum.</li>    <li>Booze.</li>    </ul>Ordered (numbered) lists use regular numbers, followed by periods, aslist markers:    1.  Red    2.  Green    3.  BlueOutput:    <ol>    <li>Red</li>    <li>Green</li>    <li>Blue</li>    </ol>If you put blank lines between items, you'll get `<p>` tags for thelist item text. You can create multi-paragraph list items by indentingthe paragraphs by 4 spaces or 1 tab:    *   A list item.            With multiple paragraphs.    *   Another item in the list.Output:    <ul>    <li><p>A list item.</p>    <p>With multiple paragraphs.</p></li>    <li><p>Another item in the list.</p></li>    </ul>    ### Links ###Markdown supports two styles for creating links: *inline* and*reference*. With both styles, you use square brackets to delimit thetext you want to turn into a link.Inline-style links use parentheses immediately after the link text.For example:    This is an [example link](http://example.com/).Output:    <p>This is an <a href="http://example.com/">    example link</a>.</p>Optionally, you may include a title attribute in the parentheses:    This is an [example link](http://example.com/ "With a Title").Output:    <p>This is an <a href="http://example.com/" title="With a Title">    example link</a>.</p>Reference-style links allow you to refer to your links by names, whichyou define elsewhere in your document:    I get 10 times more traffic from [Google][1] than from    [Yahoo][2] or [MSN][3].    [1]: http://google.com/        "Google"    [2]: http://search.yahoo.com/  "Yahoo Search"    [3]: http://search.msn.com/    "MSN Search"Output:    <p>I get 10 times more traffic from <a href="http://google.com/"    title="Google">Google</a> than from <a href="http://search.yahoo.com/"    title="Yahoo Search">Yahoo</a> or <a href="http://search.msn.com/"    title="MSN Search">MSN</a>.</p>The title attribute is optional. Link names may contain letters,numbers and spaces, but are *not* case sensitive:    I start my morning with a cup of coffee and    [The New York Times][NY Times].    [ny times]: http://www.nytimes.com/Output:    <p>I start my morning with a cup of coffee and    <a href="http://www.nytimes.com/">The New York Times</a>.</p>### Images ###Image syntax is very much like link syntax.Inline (titles are optional):    Reference-style:    ![alt text][id]    [id]: /path/to/img.jpg "Title"Both of the above examples produce the same output:    <img src="/path/to/img.jpg" alt="alt text" title="Title" />### Code ###In a regular paragraph, you can create code span by wrapping text inbacktick quotes. Any ampersands (`&`) and angle brackets (`<` or`>`) will automatically be translated into HTML entities. This makesit easy to use Markdown to write about HTML example code:    I strongly recommend against using any `<blink>` tags.    I wish SmartyPants used named entities like `&mdash;`    instead of decimal-encoded entites like `&#8212;`.Output:    <p>I strongly recommend against using any    <code>&lt;blink&gt;</code> tags.</p>        <p>I wish SmartyPants used named entities like    <code>&amp;mdash;</code> instead of decimal-encoded    entites like <code>&amp;#8212;</code>.</p>To specify an entire block of pre-formatted code, indent every line ofthe block by 4 spaces or 1 tab. Just like with code spans, `&`, `<`,and `>` characters will be escaped automatically.Markdown:    If you want your page to validate under XHTML 1.0 Strict,    you've got to put paragraph tags in your blockquotes:        <blockquote>            <p>For example.</p>        </blockquote>Output:    <p>If you want your page to validate under XHTML 1.0 Strict,    you've got to put paragraph tags in your blockquotes:</p>        <pre><code>&lt;blockquote&gt;        &lt;p&gt;For example.&lt;/p&gt;    &lt;/blockquote&gt;    </code></pre></textarea></form>    <script>      var editor = CodeMirror.fromTextArea(document.getElementById("code"), {        mode: 'markdown',        lineNumbers: true,        theme: "default",        extraKeys: {"Enter": "newlineAndIndentContinueMarkdownList"}      });    </script>    <p>Optionally depends on the XML mode for properly highlighted inline XML blocks.</p>    <p><strong>MIME types defined:</strong> <code>text/x-markdown</code>.</p>    <p><strong>Parsing/Highlighting Tests:</strong> <a href="../../test/index.html#markdown_*">normal</a>,  <a href="../../test/index.html#verbose,markdown_*">verbose</a>.</p>  </body></html>
 |