{"info":{"_postman_id":"8e60b36b-8125-cd42-61e3-5a0253ca558f","name":"Markdown in API Documentation","description":"<html><head></head><body><p><strong>This collection is intended to test markdown styling inside Postman or within other services that render Markdown. The descriptions in this collection contain markdown syntax and some of them have links to HTML pages of their rendered version.</strong></p>\n<p>If you want to test Markdown, use <a href=\"http://markdownlivepreview.com/\">http://markdownlivepreview.com/</a></p>\n<p>Also, developers love Github Markdown Styling: <a href=\"https://github.com/sindresorhus/github-markdown-css\">https://github.com/sindresorhus/github-markdown-css</a></p>\n<hr>\n<h1 id=\"an-h1-header\">An h1 header</h1>\n<p>Paragraphs are separated by a blank line.</p>\n<p>2nd paragraph. <em>Italic</em>, <strong>bold</strong>, and <code>monospace</code>. Itemized lists\nlook like:</p>\n<ul>\n<li>this one</li>\n<li>that one</li>\n<li>the other one</li>\n</ul>\n<p>Note that --- not considering the asterisk --- the actual text\ncontent starts at 4-columns in.</p>\n<blockquote>\n<p>Block quotes are\nwritten like so.</p>\n<p>They can span multiple paragraphs,\nif you like.</p>\n</blockquote>\n<p>Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex., \"it's all\nin chapters 12--14\"). Three dots ... will be converted to an ellipsis.\nUnicode is supported. ☺</p>\n<h2 id=\"an-h2-header\">An h2 header</h2>\n<p>Here's a numbered list:</p>\n<ol>\n<li>first item</li>\n<li>second item</li>\n<li>third item</li>\n</ol>\n<p>Note again how the actual text starts at 4 columns in (4 characters\nfrom the left side). Here's a code sample:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code># Let me re-iterate ...\nfor i in 1 .. 10 { do-something(i) }\n</code></pre><p>As you probably guessed, indented 4 spaces. By the way, instead of\nindenting the block, you can use delimited blocks, if you like:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>define foobar() {\n    print \"Welcome to flavor country!\";\n}\n</code></pre><p>(which makes copying &amp; pasting easier). You can optionally mark the\ndelimited block for Pandoc to syntax highlight it:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-python\">import time\n# Quick, count to ten!\nfor i in range(10):\n    # (but not *too* quick)\n    time.sleep(0.5)\n    print i\n</code></pre>\n<h3 id=\"an-h3-header\">An h3 header</h3>\n<p>Now a nested list:</p>\n<ol>\n<li><p>First, get these ingredients:</p>\n<ul>\n<li>carrots</li>\n<li>celery</li>\n<li>lentils</li>\n</ul>\n</li>\n<li><p>Boil some water.</p>\n</li>\n<li><p>Dump everything in the pot and follow\nthis algorithm:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>find wooden spoon\nuncover pot\nstir\ncover pot\nbalance wooden spoon precariously on pot handle\nwait 10 minutes\ngoto first step (or shut off burner when done)\n</code></pre><p>Do not bump wooden spoon or it will fall.</p>\n</li>\n</ol>\n<p>Notice again how text always lines up on 4-space indents (including\nthat last line which continues item 3 above).</p>\n<p>Here's a link to <a href=\"http://foo.bar\">a website</a>, to a <a href=\"local-doc.html\">local\ndoc</a>, and to a <a href=\"#an-h2-header\">section heading in the current\ndoc</a>. Here's a footnote [^1].</p>\n<p>[^1]: Footnote text goes here.</p>\n<p>Tables can look like this:</p>\n<p>size  material      color</p>\n<hr>\n<p>9     leather       brown\n10    hemp canvas   natural\n11    glass         transparent</p>\n<p>Table: Shoes, their sizes, and what they're made of</p>\n<p>(The above is the caption for the table.) Pandoc also supports\nmulti-line tables:</p>\n<hr>\n<p>keyword   text</p>\n<hr>\n<p>red       Sunsets, apples, and\n          other red or reddish\n          things.</p>\n<p>green     Leaves, grass, frogs\n          and other things it's\n          not easy being.</p>\n<hr>\n<p>A horizontal rule follows.</p>\n<hr>\n<p>Here's a definition list:</p>\n<p>apples\n  : Good for making applesauce.\noranges\n  : Citrus!\ntomatoes\n  : There's no \"e\" in tomatoe.</p>\n<p>Again, text is indented 4 spaces. (Put a blank line between each\nterm/definition pair to spread things out more.)</p>\n<p>Here's a \"line block\":</p>\n<p>| Line one\n|   Line too\n| Line tree</p>\n<p>and images can be specified like so:</p>\n<p><img src=\"https://www.getpostman.com/img/v2/logo-big.svg\" alt=\"example image\"></p>\n<p>Inline math equations go in like so: $\\omega = d\\phi / dt$. Display\nmath should get its own line and be put in in double-dollarsigns:</p>\n<p>$$I = \\int \\rho R^{2} dV$$</p>\n<p>And note that you can backslash-escape any punctuation characters\nwhich you wish to be displayed literally, ex.: `foo`, *bar*, etc.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"An h1 header","slug":"an-h1-header"}],"owner":"33232","collectionId":"8e60b36b-8125-cd42-61e3-5a0253ca558f","publishedId":"JsGc","public":true,"customColor":null,"publishDate":"2016-05-25T10:05:59.000Z"},"item":[{"name":"Basic Markdown Elements","item":[],"id":"1e3733d8-5f20-ae03-b175-6e25a2b8595d","description":"<h1 id=\"h1---this-is-h1\">H1 - This is H1</h1>\n<p>Any <strong>bar stool can graduate</strong> from a skinny Rolling Rock, but it takes a real Hommel Bier to wastedly caricature a <em>surly polar bear beer</em>. A Red Stripe, the <strong><em>Jamaica Red Ale</em></strong>, and the incinerated burglar ale are what made America great! </p>\n<ul>\n<li>This is where a UL starts</li>\n<li>More points</li>\n<li>Some more points that can go more than a line. A keg for an IPA requires assistance from some beer, or a steam engine secretly admires a Hoptoberfest around a Hefeweizen. A Pilsner related to a Jamaica Red Ale trades baseball cards with a bud dry.</li>\n</ul>\n<p>This section has <code>an inline code</code> followed by a multiline code block which should look similar to the <code>inline code</code>, except that it is a panel-like block.</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>The funny Brewers Reserve self-flagellates, and the green pit viper wakes up; however, an Avery IPA makes love to a soggy Honey Brown.\n</code></pre><h2 id=\"h2---this-h2-has-bold-and-italic\">H2 - This H2 has <strong>bold</strong> and <em>italic</em></h2>\n<p>Sometimes a salty black velvet takes a coffee break, but a dirt-encrusted Luna Sea ESB always caricatures the bud light! A Heineken inside some Jamaica Red Ale sanitizes the flatulent Pilsner. </p>\n<blockquote>\n<p>This is a Block Quote. Should look like a panel. When another bottle of beer for another Ellis Island IPA is whacked, a freight train bestows great honor upon some fat lager. The pin ball machine from some Dos Equis eats the precise coors light.</p>\n</blockquote>\n<h3 id=\"h3---this-is-bold--italic\">H3 - This is <strong><em>bold + italic</em></strong></h3>\n<p>A blood clot is raspy. A satellite brewery about the Brewers Reserve starts reminiscing about a lost buzz, and the polka-dotted Busch bestows great honor upon the Hops Alligator Ale from the lager. The dorky pool table secretly admires a tooled miller. The gratifying keg hesitantly pees on a bud light from a Guiness.</p>\n<h4 id=\"h4---this-one-link\">H4 - This one <a href=\"http://www.getpostman.com/\">link</a></h4>\n<p>When the crank case from a Dixie Beer daydreams, a college-educated Fosters wakes up. A Miller beyond the satellite brewery reads a magazine, but a so-called satellite brewery borrows money from a tanked burglar ale. Most people believe that the Hefeweizen from some Sierra Nevada throws a seldom financial scooby snack at the pompous Christmas Ale, but they need to remember how hardly a Heineken behind the bar tab ruminates. If the PBR inside another Busch cooks cheese grits for the miserly air hocky table, then the college-educated Brewers Reserve starts reminiscing about a lost buzz. A Sierra Nevada Pale Ale inside a Busch is hairy.</p>\n<h5 id=\"h5---this-one-has-a-bold-link-and-an-italic-link\">H5 - This one has a <strong><a href=\"http://www.getpostman.com/\">bold link</a></strong> and an <em><a href=\"http://www.getpostman.com/\">italic link</a></em></h5>\n<p>A Rolling Rock for a bull ice operates a small bar with the bud dry about a change. Any Keystone can make a pact with the Mango Beer around a blue moon, but it takes a real PBR to pee on the treacherous Keystone. A miller toward the IPA secretly admires an Octoberfest. A Bridgeport ESB beyond another burglar ale eats the Sierra Nevada Pale Ale related to a Pilsner.</p>\n<blockquote>\n<p>Single line block quote</p>\n</blockquote>\n<blockquote>\n<p>Multi line\nblock quote</p>\n</blockquote>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Tables</th>\n<th>Are</th>\n<th>Cool</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>col 3 is</td>\n<td>right-aligned</td>\n<td></td>\n</tr>\n<tr>\n<td>col 2 is</td>\n<td>centered</td>\n<td></td>\n</tr>\n<tr>\n<td>zebra stripes</td>\n<td>are neat</td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div>","event":[{"listen":"prerequest","script":{"id":"1e547121-fdbf-41c3-b395-c9d6678fa7ac","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e62bd284-cb4d-4791-a086-d1005b328fe4","type":"text/javascript","exec":[""]}}],"_postman_id":"1e3733d8-5f20-ae03-b175-6e25a2b8595d"},{"name":"Daring Fireball Basic Syntax","item":[],"id":"ec6be041-62f8-9442-db96-873d069f7787","description":"<p>This generates the HTML: <a href=\"http://daringfireball.net/projects/markdown/basics\">http://daringfireball.net/projects/markdown/basics</a></p>\n<h1 id=\"markdown-basics\">Markdown: Basics</h1>\n<ul>\n    <li><a href=\"/projects/markdown/\">Main</a></li>\n    <li><a>Basics</a></li>\n    <li><a href=\"/projects/markdown/syntax\">Syntax</a></li>\n    <li><a href=\"/projects/markdown/license\">License</a></li>\n    <li><a href=\"/projects/markdown/dingus\">Dingus</a></li>\n</ul>\n\n\n<h2 id=\"getting-the-gist-of-markdowns-formatting-syntax\">Getting the Gist of Markdown's Formatting Syntax</h2>\n<p>This page offers a brief overview of what it's like to use Markdown.\nThe [syntax page] <a href=\"/projects/markdown/syntax\">s</a> provides complete, detailed documentation for\nevery feature, but Markdown should be very easy to pick up simply by\nlooking at a few examples of it in action. The examples on this page\nare written in a before/after style, showing example syntax and the\nHTML output produced by Markdown.</p>\n<p>It's also helpful to simply try Markdown out; the [Dingus] <a href=\"/projects/markdown/dingus\">d</a> is a\nweb application that allows you type your own Markdown-formatted text\nand translate it to XHTML.</p>\n<p><strong>Note:</strong> This document is itself written using Markdown; you\ncan [see the source for it by adding '.text' to the URL] <a href=\"/projects/markdown/basics.text\">src</a>.</p>\n<h2 id=\"paragraphs-headers-blockquotes\">Paragraphs, Headers, Blockquotes</h2>\n<p>A paragraph is simply one or more consecutive lines of text, separated\nby one or more blank lines. (A blank line is any line that looks like\na blank line -- a line containing nothing but spaces or tabs is\nconsidered blank.) Normal paragraphs should not be indented with\nspaces or tabs.</p>\n<p>Markdown offers two styles of headers: <em>Setext</em> and <em>atx</em>.\nSetext-style headers for <code>&lt;h1&gt;</code> and <code>&lt;h2&gt;</code> are created by\n\"underlining\" with equal signs (<code>=</code>) and hyphens (<code>-</code>), respectively.\nTo create an atx-style header, you put 1-6 hash marks (<code>#</code>) at the\nbeginning of the line -- the number of hashes equals the resulting\nHTML header level.</p>\n<p>Blockquotes are indicated using email-style '<code>&gt;</code>' angle brackets.</p>\n<p>Markdown:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>A First Level Header\n====================\n\nA Second Level Header\n---------------------\n\nNow is the time for all good men to come to\nthe aid of their country. This is just a\nregular paragraph.\n\nThe quick brown fox jumped over the lazy\ndog's back.\n\n### Header 3\n\n&gt; This is a blockquote.\n&gt; \n&gt; This is the second paragraph in the blockquote.\n&gt;\n&gt; ## This is an H2 in a blockquote\n</code></pre><p>Output:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;h1&gt;A First Level Header&lt;/h1&gt;\n\n&lt;h2&gt;A Second Level Header&lt;/h2&gt;\n\n&lt;p&gt;Now is the time for all good men to come to\nthe aid of their country. This is just a\nregular paragraph.&lt;/p&gt;\n\n&lt;p&gt;The quick brown fox jumped over the lazy\ndog's back.&lt;/p&gt;\n\n&lt;h3&gt;Header 3&lt;/h3&gt;\n\n&lt;blockquote&gt;\n    &lt;p&gt;This is a blockquote.&lt;/p&gt;\n    \n    &lt;p&gt;This is the second paragraph in the blockquote.&lt;/p&gt;\n    \n    &lt;h2&gt;This is an H2 in a blockquote&lt;/h2&gt;\n&lt;/blockquote&gt;\n</code></pre><h3 id=\"phrase-emphasis\">Phrase Emphasis</h3>\n<p>Markdown uses asterisks and underscores to indicate spans of emphasis.</p>\n<p>Markdown:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>Some of these words *are emphasized*.\nSome of these words _are emphasized also_.\n\nUse two asterisks for **strong emphasis**.\nOr, if you prefer, __use two underscores instead__.\n</code></pre><p>Output:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;Some of these words &lt;em&gt;are emphasized&lt;/em&gt;.\nSome of these words &lt;em&gt;are emphasized also&lt;/em&gt;.&lt;/p&gt;\n\n&lt;p&gt;Use two asterisks for &lt;strong&gt;strong emphasis&lt;/strong&gt;.\nOr, if you prefer, &lt;strong&gt;use two underscores instead&lt;/strong&gt;.&lt;/p&gt;\n</code></pre><h2 id=\"lists\">Lists</h2>\n<p>Unordered (bulleted) lists use asterisks, pluses, and hyphens (<code>*</code>,\n<code>+</code>, and <code>-</code>) as list markers. These three markers are\ninterchangable; this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>*   Candy.\n*   Gum.\n*   Booze.\n</code></pre><p>this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>+   Candy.\n+   Gum.\n+   Booze.\n</code></pre><p>and this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>-   Candy.\n-   Gum.\n-   Booze.\n</code></pre><p>all produce the same output:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;ul&gt;\n&lt;li&gt;Candy.&lt;/li&gt;\n&lt;li&gt;Gum.&lt;/li&gt;\n&lt;li&gt;Booze.&lt;/li&gt;\n&lt;/ul&gt;\n</code></pre><p>Ordered (numbered) lists use regular numbers, followed by periods, as\nlist markers:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>1.  Red\n2.  Green\n3.  Blue\n</code></pre><p>Output:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;ol&gt;\n&lt;li&gt;Red&lt;/li&gt;\n&lt;li&gt;Green&lt;/li&gt;\n&lt;li&gt;Blue&lt;/li&gt;\n&lt;/ol&gt;\n</code></pre><p>If you put blank lines between items, you'll get <code>&lt;p&gt;</code> tags for the\nlist item text. You can create multi-paragraph list items by indenting\nthe paragraphs by 4 spaces or 1 tab:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>*   A list item.\n\n    With multiple paragraphs.\n\n*   Another item in the list.\n</code></pre><p>Output:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;ul&gt;\n&lt;li&gt;&lt;p&gt;A list item.&lt;/p&gt;\n&lt;p&gt;With multiple paragraphs.&lt;/p&gt;&lt;/li&gt;\n&lt;li&gt;&lt;p&gt;Another item in the list.&lt;/p&gt;&lt;/li&gt;\n&lt;/ul&gt;\n</code></pre><h3 id=\"links\">Links</h3>\n<p>Markdown supports two styles for creating links: <em>inline</em> and\n<em>reference</em>. With both styles, you use square brackets to delimit the\ntext you want to turn into a link.</p>\n<p>Inline-style links use parentheses immediately after the link text.\nFor example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>This is an [example link](http://example.com/).\n</code></pre><p>Output:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;This is an &lt;a href=\"http://example.com/\"&gt;\nexample link&lt;/a&gt;.&lt;/p&gt;\n</code></pre><p>Optionally, you may include a title attribute in the parentheses:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>This is an [example link](http://example.com/ \"With a Title\").\n</code></pre><p>Output:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;This is an &lt;a href=\"http://example.com/\" title=\"With a Title\"&gt;\nexample link&lt;/a&gt;.&lt;/p&gt;\n</code></pre><p>Reference-style links allow you to refer to your links by names, which\nyou define elsewhere in your document:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>I get 10 times more traffic from [Google][1] than from\n[Yahoo][2] or [MSN][3].\n\n[1]: http://google.com/        \"Google\"\n[2]: http://search.yahoo.com/  \"Yahoo Search\"\n[3]: http://search.msn.com/    \"MSN Search\"\n</code></pre><p>Output:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;I get 10 times more traffic from &lt;a href=\"http://google.com/\"\ntitle=\"Google\"&gt;Google&lt;/a&gt; than from &lt;a href=\"http://search.yahoo.com/\"\ntitle=\"Yahoo Search\"&gt;Yahoo&lt;/a&gt; or &lt;a href=\"http://search.msn.com/\"\ntitle=\"MSN Search\"&gt;MSN&lt;/a&gt;.&lt;/p&gt;\n</code></pre><p>The title attribute is optional. Link names may contain letters,\nnumbers and spaces, but are <em>not</em> case sensitive:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>I start my morning with a cup of coffee and\n[The New York Times][NY Times].\n\n[ny times]: http://www.nytimes.com/\n</code></pre><p>Output:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;I start my morning with a cup of coffee and\n&lt;a href=\"http://www.nytimes.com/\"&gt;The New York Times&lt;/a&gt;.&lt;/p&gt;\n</code></pre><h3 id=\"images\">Images</h3>\n<p>Image syntax is very much like link syntax.</p>\n<p>Inline (titles are optional):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>![alt text](/path/to/img.jpg \"Title\")\n</code></pre><p>Reference-style:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>![alt text][id]\n\n[id]: /path/to/img.jpg \"Title\"\n</code></pre><p>Both of the above examples produce the same output:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;img src=\"/path/to/img.jpg\" alt=\"alt text\" title=\"Title\" /&gt;\n</code></pre><h3 id=\"code\">Code</h3>\n<p>In a regular paragraph, you can create code span by wrapping text in\nbacktick quotes. Any ampersands (<code>&amp;</code>) and angle brackets (<code>&lt;</code> or\n<code>&gt;</code>) will automatically be translated into HTML entities. This makes\nit easy to use Markdown to write about HTML example code:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>I strongly recommend against using any `&lt;blink&gt;` tags.\n\nI wish SmartyPants used named entities like `&amp;mdash;`\ninstead of decimal-encoded entites like `&amp;#8212;`.\n</code></pre><p>Output:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;I strongly recommend against using any\n&lt;code&gt;&amp;lt;blink&amp;gt;&lt;/code&gt; tags.&lt;/p&gt;\n\n&lt;p&gt;I wish SmartyPants used named entities like\n&lt;code&gt;&amp;amp;mdash;&lt;/code&gt; instead of decimal-encoded\nentites like &lt;code&gt;&amp;amp;#8212;&lt;/code&gt;.&lt;/p&gt;\n</code></pre><p>To specify an entire block of pre-formatted code, indent every line of\nthe block by 4 spaces or 1 tab. Just like with code spans, <code>&amp;</code>, <code>&lt;</code>,\nand <code>&gt;</code> characters will be escaped automatically.</p>\n<p>Markdown:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>If you want your page to validate under XHTML 1.0 Strict,\nyou've got to put paragraph tags in your blockquotes:\n\n    &lt;blockquote&gt;\n        &lt;p&gt;For example.&lt;/p&gt;\n    &lt;/blockquote&gt;\n</code></pre><p>Output:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;If you want your page to validate under XHTML 1.0 Strict,\nyou've got to put paragraph tags in your blockquotes:&lt;/p&gt;\n\n&lt;pre&gt;&lt;code&gt;&amp;lt;blockquote&amp;gt;\n    &amp;lt;p&amp;gt;For example.&amp;lt;/p&amp;gt;\n&amp;lt;/blockquote&amp;gt;\n&lt;/code&gt;&lt;/pre&gt;\n</code></pre>","_postman_id":"ec6be041-62f8-9442-db96-873d069f7787"},{"name":"Daring Fireball Extended Syntax","item":[],"id":"250c5e50-7091-1e40-9e78-efe20ab41357","description":"<p>This is the source of the page:\n<a href=\"http://daringfireball.net/projects/markdown/syntax\">http://daringfireball.net/projects/markdown/syntax</a></p>\n<h1 id=\"markdown-syntax\">Markdown: Syntax</h1>\n<ul>\n    <li><a href=\"/projects/markdown/\">Main</a></li>\n    <li><a href=\"/projects/markdown/basics\">Basics</a></li>\n    <li><a>Syntax</a></li>\n    <li><a href=\"/projects/markdown/license\">License</a></li>\n    <li><a href=\"/projects/markdown/dingus\">Dingus</a></li>\n</ul>\n\n\n<ul>\n<li><a href=\"#overview\">Overview</a><ul>\n<li><a href=\"#philosophy\">Philosophy</a></li>\n<li><a href=\"#html\">Inline HTML</a></li>\n<li><a href=\"#autoescape\">Automatic Escaping for Special Characters</a></li>\n</ul>\n</li>\n<li><a href=\"#block\">Block Elements</a><ul>\n<li><a href=\"#p\">Paragraphs and Line Breaks</a></li>\n<li><a href=\"#header\">Headers</a></li>\n<li><a href=\"#blockquote\">Blockquotes</a></li>\n<li><a href=\"#list\">Lists</a></li>\n<li><a href=\"#precode\">Code Blocks</a></li>\n<li><a href=\"#hr\">Horizontal Rules</a></li>\n</ul>\n</li>\n<li><a href=\"#span\">Span Elements</a><ul>\n<li><a href=\"#link\">Links</a></li>\n<li><a href=\"#em\">Emphasis</a></li>\n<li><a href=\"#code\">Code</a></li>\n<li><a href=\"#img\">Images</a></li>\n</ul>\n</li>\n<li><a href=\"#misc\">Miscellaneous</a><ul>\n<li><a href=\"#backslash\">Backslash Escapes</a></li>\n<li><a href=\"#autolink\">Automatic Links</a></li>\n</ul>\n</li>\n</ul>\n<p><strong>Note:</strong> This document is itself written using Markdown; you\ncan <a href=\"/projects/markdown/syntax.text\">see the source for it by adding '.text' to the URL</a>.</p>\n<hr />\n<h2 id=\"overview\">Overview</h2>\n\n<h3 id=\"philosophy\">Philosophy</h3>\n\n<p>Markdown is intended to be as easy-to-read and easy-to-write as is feasible.</p>\n<p>Readability, however, is emphasized above all else. A Markdown-formatted\ndocument should be publishable as-is, as plain text, without looking\nlike it's been marked up with tags or formatting instructions. While\nMarkdown's syntax has been influenced by several existing text-to-HTML\nfilters -- including [Setext] <a href=\"http://docutils.sourceforge.net/mirror/setext.html\">1</a>, [atx] <a href=\"http://www.aaronsw.com/2002/atx/\">2</a>, [Textile] <a href=\"http://textism.com/tools/textile/\">3</a>, [reStructuredText] <a href=\"http://docutils.sourceforge.net/rst.html\">4</a>,\n[Grutatext] <a href=\"http://www.triptico.com/software/grutatxt.html\">5</a>, and [EtText] <a href=\"http://ettext.taint.org/doc/\">6</a> -- the single biggest source of\ninspiration for Markdown's syntax is the format of plain text email.</p>\n<p>To this end, Markdown's syntax is comprised entirely of punctuation\ncharacters, which punctuation characters have been carefully chosen so\nas to look like what they mean. E.g., asterisks around a word actually\nlook like *emphasis*. Markdown lists look like, well, lists. Even\nblockquotes look like quoted passages of text, assuming you've ever\nused email.</p>\n<h3 id=\"html\">Inline HTML</h3>\n\n<p>Markdown's syntax is intended for one purpose: to be used as a\nformat for <em>writing</em> for the web.</p>\n<p>Markdown is not a replacement for HTML, or even close to it. Its\nsyntax is very small, corresponding only to a very small subset of\nHTML tags. The idea is <em>not</em> to create a syntax that makes it easier\nto insert HTML tags. In my opinion, HTML tags are already easy to\ninsert. The idea for Markdown is to make it easy to read, write, and\nedit prose. HTML is a <em>publishing</em> format; Markdown is a <em>writing</em>\nformat. Thus, Markdown's formatting syntax only addresses issues that\ncan be conveyed in plain text.</p>\n<p>For any markup that is not covered by Markdown's syntax, you simply\nuse HTML itself. There's no need to preface it or delimit it to\nindicate that you're switching from Markdown to HTML; you just use\nthe tags.</p>\n<p>The only restrictions are that block-level HTML elements -- e.g. <code>&lt;div&gt;</code>,\n<code>&lt;table&gt;</code>, <code>&lt;pre&gt;</code>, <code>&lt;p&gt;</code>, etc. -- must be separated from surrounding\ncontent by blank lines, and the start and end tags of the block should\nnot be indented with tabs or spaces. Markdown is smart enough not\nto add extra (unwanted) <code>&lt;p&gt;</code> tags around HTML block-level tags.</p>\n<p>For example, to add an HTML table to a Markdown article:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>This is a regular paragraph.\n\n&lt;table&gt;\n    &lt;tr&gt;\n        &lt;td&gt;Foo&lt;/td&gt;\n    &lt;/tr&gt;\n&lt;/table&gt;\n\nThis is another regular paragraph.\n</code></pre><p>Note that Markdown formatting syntax is not processed within block-level\nHTML tags. E.g., you can't use Markdown-style <code>*emphasis*</code> inside an\nHTML block.</p>\n<p>Span-level HTML tags -- e.g. <code>&lt;span&gt;</code>, <code>&lt;cite&gt;</code>, or <code>&lt;del&gt;</code> -- can be\nused anywhere in a Markdown paragraph, list item, or header. If you\nwant, you can even use HTML tags instead of Markdown formatting; e.g. if\nyou'd prefer to use HTML <code>&lt;a&gt;</code> or <code>&lt;img&gt;</code> tags instead of Markdown's\nlink or image syntax, go right ahead.</p>\n<p>Unlike block-level HTML tags, Markdown syntax <em>is</em> processed within\nspan-level tags.</p>\n<h3 id=\"autoescape\">Automatic Escaping for Special Characters</h3>\n\n<p>In HTML, there are two characters that demand special treatment: <code>&lt;</code>\nand <code>&amp;</code>. Left angle brackets are used to start tags; ampersands are\nused to denote HTML entities. If you want to use them as literal\ncharacters, you must escape them as entities, e.g. <code>&amp;lt;</code>, and\n<code>&amp;amp;</code>.</p>\n<p>Ampersands in particular are bedeviling for web writers. If you want to\nwrite about 'AT&amp;T', you need to write '<code>AT&amp;amp;T</code>'. You even need to\nescape ampersands within URLs. Thus, if you want to link to:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>http://images.google.com/images?num=30&amp;q=larry+bird\n</code></pre><p>you need to encode the URL as:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>http://images.google.com/images?num=30&amp;amp;q=larry+bird\n</code></pre><p>in your anchor tag <code>href</code> attribute. Needless to say, this is easy to\nforget, and is probably the single most common source of HTML validation\nerrors in otherwise well-marked-up web sites.</p>\n<p>Markdown allows you to use these characters naturally, taking care of\nall the necessary escaping for you. If you use an ampersand as part of\nan HTML entity, it remains unchanged; otherwise it will be translated\ninto <code>&amp;amp;</code>.</p>\n<p>So, if you want to include a copyright symbol in your article, you can write:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&amp;copy;\n</code></pre><p>and Markdown will leave it alone. But if you write:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>AT&amp;T\n</code></pre><p>Markdown will translate it to:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>AT&amp;amp;T\n</code></pre><p>Similarly, because Markdown supports <a href=\"#html\">inline HTML</a>, if you use\nangle brackets as delimiters for HTML tags, Markdown will treat them as\nsuch. But if you write:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>4 &lt; 5\n</code></pre><p>Markdown will translate it to:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>4 &amp;lt; 5\n</code></pre><p>However, inside Markdown code spans and blocks, angle brackets and\nampersands are <em>always</em> encoded automatically. This makes it easy to use\nMarkdown to write about HTML code. (As opposed to raw HTML, which is a\nterrible format for writing about HTML syntax, because every single <code>&lt;</code>\nand <code>&amp;</code> in your example code needs to be escaped.)</p>\n<hr />\n<h2 id=\"block\">Block Elements</h2>\n\n\n<h3 id=\"p\">Paragraphs and Line Breaks</h3>\n\n<p>A paragraph is simply one or more consecutive lines of text, separated\nby one or more blank lines. (A blank line is any line that looks like a\nblank line -- a line containing nothing but spaces or tabs is considered\nblank.) Normal paragraphs should not be indented with spaces or tabs.</p>\n<p>The implication of the \"one or more consecutive lines of text\" rule is\nthat Markdown supports \"hard-wrapped\" text paragraphs. This differs\nsignificantly from most other text-to-HTML formatters (including Movable\nType's \"Convert Line Breaks\" option) which translate every line break\ncharacter in a paragraph into a <code>&lt;br /&gt;</code> tag.</p>\n<p>When you <em>do</em> want to insert a <code>&lt;br /&gt;</code> break tag using Markdown, you\nend a line with two or more spaces, then type return.</p>\n<p>Yes, this takes a tad more effort to create a <code>&lt;br /&gt;</code>, but a simplistic\n\"every line break is a <code>&lt;br /&gt;</code>\" rule wouldn't work for Markdown.\nMarkdown's email-style <a href=\"#blockquote\">blockquoting</a> and multi-paragraph <a href=\"#list\">list items</a>\nwork best -- and look better -- when you format them with hard breaks.</p>\n<h3 id=\"header\">Headers</h3>\n\n<p>Markdown supports two styles of headers, [Setext] <a href=\"http://docutils.sourceforge.net/mirror/setext.html\">1</a> and [atx] <a href=\"http://www.aaronsw.com/2002/atx/\">2</a>.</p>\n<p>Setext-style headers are \"underlined\" using equal signs (for first-level\nheaders) and dashes (for second-level headers). For example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>This is an H1\n=============\n\nThis is an H2\n-------------\n</code></pre><p>Any number of underlining <code>=</code>'s or <code>-</code>'s will work.</p>\n<p>Atx-style headers use 1-6 hash characters at the start of the line,\ncorresponding to header levels 1-6. For example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code># This is an H1\n\n## This is an H2\n\n###### This is an H6\n</code></pre><p>Optionally, you may \"close\" atx-style headers. This is purely\ncosmetic -- you can use this if you think it looks better. The\nclosing hashes don't even need to match the number of hashes\nused to open the header. (The number of opening hashes\ndetermines the header level.) :</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code># This is an H1 #\n\n## This is an H2 ##\n\n### This is an H3 ######\n</code></pre><h3 id=\"blockquote\">Blockquotes</h3>\n\n<p>Markdown uses email-style <code>&gt;</code> characters for blockquoting. If you're\nfamiliar with quoting passages of text in an email message, then you\nknow how to create a blockquote in Markdown. It looks best if you hard\nwrap the text and put a <code>&gt;</code> before every line:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&gt; This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,\n&gt; consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.\n&gt; Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.\n&gt; \n&gt; Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse\n&gt; id sem consectetuer libero luctus adipiscing.\n</code></pre><p>Markdown allows you to be lazy and only put the <code>&gt;</code> before the first\nline of a hard-wrapped paragraph:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&gt; This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,\nconsectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.\nVestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.\n\n&gt; Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse\nid sem consectetuer libero luctus adipiscing.\n</code></pre><p>Blockquotes can be nested (i.e. a blockquote-in-a-blockquote) by\nadding additional levels of <code>&gt;</code>:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&gt; This is the first level of quoting.\n&gt;\n&gt; &gt; This is nested blockquote.\n&gt;\n&gt; Back to the first level.\n</code></pre><p>Blockquotes can contain other Markdown elements, including headers, lists,\nand code blocks:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&gt; ## This is a header.\n&gt; \n&gt; 1.   This is the first list item.\n&gt; 2.   This is the second list item.\n&gt; \n&gt; Here's some example code:\n&gt; \n&gt;     return shell_exec(\"echo $input | $markdown_script\");\n</code></pre><p>Any decent text editor should make email-style quoting easy. For\nexample, with BBEdit, you can make a selection and choose Increase\nQuote Level from the Text menu.</p>\n<h3 id=\"list\">Lists</h3>\n\n<p>Markdown supports ordered (numbered) and unordered (bulleted) lists.</p>\n<p>Unordered lists use asterisks, pluses, and hyphens -- interchangably\n-- as list markers:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>*   Red\n*   Green\n*   Blue\n</code></pre><p>is equivalent to:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>+   Red\n+   Green\n+   Blue\n</code></pre><p>and:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>-   Red\n-   Green\n-   Blue\n</code></pre><p>Ordered lists use numbers followed by periods:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>1.  Bird\n2.  McHale\n3.  Parish\n</code></pre><p>It's important to note that the actual numbers you use to mark the\nlist have no effect on the HTML output Markdown produces. The HTML\nMarkdown produces from the above list is:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;ol&gt;\n&lt;li&gt;Bird&lt;/li&gt;\n&lt;li&gt;McHale&lt;/li&gt;\n&lt;li&gt;Parish&lt;/li&gt;\n&lt;/ol&gt;\n</code></pre><p>If you instead wrote the list in Markdown like this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>1.  Bird\n1.  McHale\n1.  Parish\n</code></pre><p>or even:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>3. Bird\n1. McHale\n8. Parish\n</code></pre><p>you'd get the exact same HTML output. The point is, if you want to,\nyou can use ordinal numbers in your ordered Markdown lists, so that\nthe numbers in your source match the numbers in your published HTML.\nBut if you want to be lazy, you don't have to.</p>\n<p>If you do use lazy list numbering, however, you should still start the\nlist with the number 1. At some point in the future, Markdown may support\nstarting ordered lists at an arbitrary number.</p>\n<p>List markers typically start at the left margin, but may be indented by\nup to three spaces. List markers must be followed by one or more spaces\nor a tab.</p>\n<p>To make lists look nice, you can wrap items with hanging indents:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>*   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.\n    Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,\n    viverra nec, fringilla in, laoreet vitae, risus.\n*   Donec sit amet nisl. Aliquam semper ipsum sit amet velit.\n    Suspendisse id sem consectetuer libero luctus adipiscing.\n</code></pre><p>But if you want to be lazy, you don't have to:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>*   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.\nAliquam hendrerit mi posuere lectus. Vestibulum enim wisi,\nviverra nec, fringilla in, laoreet vitae, risus.\n*   Donec sit amet nisl. Aliquam semper ipsum sit amet velit.\nSuspendisse id sem consectetuer libero luctus adipiscing.\n</code></pre><p>If list items are separated by blank lines, Markdown will wrap the\nitems in <code>&lt;p&gt;</code> tags in the HTML output. For example, this input:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>*   Bird\n*   Magic\n</code></pre><p>will turn into:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;ul&gt;\n&lt;li&gt;Bird&lt;/li&gt;\n&lt;li&gt;Magic&lt;/li&gt;\n&lt;/ul&gt;\n</code></pre><p>But this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>*   Bird\n\n*   Magic\n</code></pre><p>will turn into:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;ul&gt;\n&lt;li&gt;&lt;p&gt;Bird&lt;/p&gt;&lt;/li&gt;\n&lt;li&gt;&lt;p&gt;Magic&lt;/p&gt;&lt;/li&gt;\n&lt;/ul&gt;\n</code></pre><p>List items may consist of multiple paragraphs. Each subsequent\nparagraph in a list item must be indented by either 4 spaces\nor one tab:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>1.  This is a list item with two paragraphs. Lorem ipsum dolor\n    sit amet, consectetuer adipiscing elit. Aliquam hendrerit\n    mi posuere lectus.\n\n    Vestibulum enim wisi, viverra nec, fringilla in, laoreet\n    vitae, risus. Donec sit amet nisl. Aliquam semper ipsum\n    sit amet velit.\n\n2.  Suspendisse id sem consectetuer libero luctus adipiscing.\n</code></pre><p>It looks nice if you indent every line of the subsequent\nparagraphs, but here again, Markdown will allow you to be\nlazy:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>*   This is a list item with two paragraphs.\n\n    This is the second paragraph in the list item. You're\nonly required to indent the first line. Lorem ipsum dolor\nsit amet, consectetuer adipiscing elit.\n\n*   Another item in the same list.\n</code></pre><p>To put a blockquote within a list item, the blockquote's <code>&gt;</code>\ndelimiters need to be indented:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>*   A list item with a blockquote:\n\n    &gt; This is a blockquote\n    &gt; inside a list item.\n</code></pre><p>To put a code block within a list item, the code block needs\nto be indented <em>twice</em> -- 8 spaces or two tabs:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>*   A list item with a code block:\n\n        &lt;code goes here&gt;\n</code></pre><p>It's worth noting that it's possible to trigger an ordered list by\naccident, by writing something like this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>1986. What a great season.\n</code></pre><p>In other words, a <em>number-period-space</em> sequence at the beginning of a\nline. To avoid this, you can backslash-escape the period:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>1986\\. What a great season.\n</code></pre><h3 id=\"precode\">Code Blocks</h3>\n\n<p>Pre-formatted code blocks are used for writing about programming or\nmarkup source code. Rather than forming normal paragraphs, the lines\nof a code block are interpreted literally. Markdown wraps a code block\nin both <code>&lt;pre&gt;</code> and <code>&lt;code&gt;</code> tags.</p>\n<p>To produce a code block in Markdown, simply indent every line of the\nblock by at least 4 spaces or 1 tab. For example, given this input:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>This is a normal paragraph:\n\n    This is a code block.\n</code></pre><p>Markdown will generate:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;This is a normal paragraph:&lt;/p&gt;\n\n&lt;pre&gt;&lt;code&gt;This is a code block.\n&lt;/code&gt;&lt;/pre&gt;\n</code></pre><p>One level of indentation -- 4 spaces or 1 tab -- is removed from each\nline of the code block. For example, this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>Here is an example of AppleScript:\n\n    tell application \"Foo\"\n        beep\n    end tell\n</code></pre><p>will turn into:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;Here is an example of AppleScript:&lt;/p&gt;\n\n&lt;pre&gt;&lt;code&gt;tell application \"Foo\"\n    beep\nend tell\n&lt;/code&gt;&lt;/pre&gt;\n</code></pre><p>A code block continues until it reaches a line that is not indented\n(or the end of the article).</p>\n<p>Within a code block, ampersands (<code>&amp;</code>) and angle brackets (<code>&lt;</code> and <code>&gt;</code>)\nare automatically converted into HTML entities. This makes it very\neasy to include example HTML source code using Markdown -- just paste\nit and indent it, and Markdown will handle the hassle of encoding the\nampersands and angle brackets. For example, this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>    &lt;div class=\"footer\"&gt;\n        &amp;copy; 2004 Foo Corporation\n    &lt;/div&gt;\n</code></pre><p>will turn into:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;pre&gt;&lt;code&gt;&amp;lt;div class=\"footer\"&amp;gt;\n    &amp;amp;copy; 2004 Foo Corporation\n&amp;lt;/div&amp;gt;\n&lt;/code&gt;&lt;/pre&gt;\n</code></pre><p>Regular Markdown syntax is not processed within code blocks. E.g.,\nasterisks are just literal asterisks within a code block. This means\nit's also easy to use Markdown to write about Markdown's own syntax.</p>\n<h3 id=\"hr\">Horizontal Rules</h3>\n\n<p>You can produce a horizontal rule tag (<code>&lt;hr /&gt;</code>) by placing three or\nmore hyphens, asterisks, or underscores on a line by themselves. If you\nwish, you may use spaces between the hyphens or asterisks. Each of the\nfollowing lines will produce a horizontal rule:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>* * *\n\n***\n\n*****\n\n- - -\n\n---------------------------------------\n</code></pre><hr />\n<h2 id=\"span\">Span Elements</h2>\n\n<h3 id=\"link\">Links</h3>\n\n<p>Markdown supports two style of links: <em>inline</em> and <em>reference</em>.</p>\n<p>In both styles, the link text is delimited by [square brackets].</p>\n<p>To create an inline link, use a set of regular parentheses immediately\nafter the link text's closing square bracket. Inside the parentheses,\nput the URL where you want the link to point, along with an <em>optional</em>\ntitle for the link, surrounded in quotes. For example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>This is [an example](http://example.com/ \"Title\") inline link.\n\n[This link](http://example.net/) has no title attribute.\n</code></pre><p>Will produce:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;This is &lt;a href=\"http://example.com/\" title=\"Title\"&gt;\nan example&lt;/a&gt; inline link.&lt;/p&gt;\n\n&lt;p&gt;&lt;a href=\"http://example.net/\"&gt;This link&lt;/a&gt; has no\ntitle attribute.&lt;/p&gt;\n</code></pre><p>If you're referring to a local resource on the same server, you can\nuse relative paths:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>See my [About](/about/) page for details.   \n</code></pre><p>Reference-style links use a second set of square brackets, inside\nwhich you place a label of your choosing to identify the link:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>This is [an example][id] reference-style link.\n</code></pre><p>You can optionally use a space to separate the sets of brackets:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>This is [an example] [id] reference-style link.\n</code></pre><p>Then, anywhere in the document, you define your link label like this,\non a line by itself:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[id]: http://example.com/  \"Optional Title Here\"\n</code></pre><p>That is:</p>\n<ul>\n<li>Square brackets containing the link identifier (optionally\nindented from the left margin using up to three spaces);</li>\n<li>followed by a colon;</li>\n<li>followed by one or more spaces (or tabs);</li>\n<li>followed by the URL for the link;</li>\n<li>optionally followed by a title attribute for the link, enclosed\nin double or single quotes, or enclosed in parentheses.</li>\n</ul>\n<p>The following three link definitions are equivalent:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[foo]: http://example.com/  \"Optional Title Here\"\n[foo]: http://example.com/  'Optional Title Here'\n[foo]: http://example.com/  (Optional Title Here)\n</code></pre><p><strong>Note:</strong> There is a known bug in Markdown.pl 1.0.1 which prevents\nsingle quotes from being used to delimit link titles.</p>\n<p>The link URL may, optionally, be surrounded by angle brackets:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[id]: &lt;http://example.com/&gt;  \"Optional Title Here\"\n</code></pre><p>You can put the title attribute on the next line and use extra spaces\nor tabs for padding, which tends to look better with longer URLs:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[id]: http://example.com/longish/path/to/resource/here\n    \"Optional Title Here\"\n</code></pre><p>Link definitions are only used for creating links during Markdown\nprocessing, and are stripped from your document in the HTML output.</p>\n<p>Link definition names may consist of letters, numbers, spaces, and\npunctuation -- but they are <em>not</em> case sensitive. E.g. these two\nlinks:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[link text][a]\n[link text][A]\n</code></pre><p>are equivalent.</p>\n<p>The <em>implicit link name</em> shortcut allows you to omit the name of the\nlink, in which case the link text itself is used as the name.\nJust use an empty set of square brackets -- e.g., to link the word\n\"Google\" to the google.com web site, you could simply write:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[Google][]\n</code></pre><p>And then define the link:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[Google]: http://google.com/\n</code></pre><p>Because link names may contain spaces, this shortcut even works for\nmultiple words in the link text:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>Visit [Daring Fireball][] for more information.\n</code></pre><p>And then define the link:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[Daring Fireball]: http://daringfireball.net/\n</code></pre><p>Link definitions can be placed anywhere in your Markdown document. I\ntend to put them immediately after each paragraph in which they're\nused, but if you want, you can put them all at the end of your\ndocument, sort of like footnotes.</p>\n<p>Here's an example of reference links in action:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>I get 10 times more traffic from [Google] [1] than from\n[Yahoo] [2] or [MSN] [3].\n\n  [1]: http://google.com/        \"Google\"\n  [2]: http://search.yahoo.com/  \"Yahoo Search\"\n  [3]: http://search.msn.com/    \"MSN Search\"\n</code></pre><p>Using the implicit link name shortcut, you could instead write:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>I get 10 times more traffic from [Google][] than from\n[Yahoo][] or [MSN][].\n\n  [google]: http://google.com/        \"Google\"\n  [yahoo]:  http://search.yahoo.com/  \"Yahoo Search\"\n  [msn]:    http://search.msn.com/    \"MSN Search\"\n</code></pre><p>Both of the above examples will produce the following HTML output:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;I get 10 times more traffic from &lt;a href=\"http://google.com/\"\ntitle=\"Google\"&gt;Google&lt;/a&gt; than from\n&lt;a href=\"http://search.yahoo.com/\" title=\"Yahoo Search\"&gt;Yahoo&lt;/a&gt;\nor &lt;a href=\"http://search.msn.com/\" title=\"MSN Search\"&gt;MSN&lt;/a&gt;.&lt;/p&gt;\n</code></pre><p>For comparison, here is the same paragraph written using\nMarkdown's inline link style:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>I get 10 times more traffic from [Google](http://google.com/ \"Google\")\nthan from [Yahoo](http://search.yahoo.com/ \"Yahoo Search\") or\n[MSN](http://search.msn.com/ \"MSN Search\").\n</code></pre><p>The point of reference-style links is not that they're easier to\nwrite. The point is that with reference-style links, your document\nsource is vastly more readable. Compare the above examples: using\nreference-style links, the paragraph itself is only 81 characters\nlong; with inline-style links, it's 176 characters; and as raw HTML,\nit's 234 characters. In the raw HTML, there's more markup than there\nis text.</p>\n<p>With Markdown's reference-style links, a source document much more\nclosely resembles the final output, as rendered in a browser. By\nallowing you to move the markup-related metadata out of the paragraph,\nyou can add links without interrupting the narrative flow of your\nprose.</p>\n<h3 id=\"em\">Emphasis</h3>\n\n<p>Markdown treats asterisks (<code>*</code>) and underscores (<code>_</code>) as indicators of\nemphasis. Text wrapped with one <code>*</code> or <code>_</code> will be wrapped with an\nHTML <code>&lt;em&gt;</code> tag; double <code>*</code>'s or <code>_</code>'s will be wrapped with an HTML\n<code>&lt;strong&gt;</code> tag. E.g., this input:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>*single asterisks*\n\n_single underscores_\n\n**double asterisks**\n\n__double underscores__\n</code></pre><p>will produce:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;em&gt;single asterisks&lt;/em&gt;\n\n&lt;em&gt;single underscores&lt;/em&gt;\n\n&lt;strong&gt;double asterisks&lt;/strong&gt;\n\n&lt;strong&gt;double underscores&lt;/strong&gt;\n</code></pre><p>You can use whichever style you prefer; the lone restriction is that\nthe same character must be used to open and close an emphasis span.</p>\n<p>Emphasis can be used in the middle of a word:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>un*frigging*believable\n</code></pre><p>But if you surround an <code>*</code> or <code>_</code> with spaces, it'll be treated as a\nliteral asterisk or underscore.</p>\n<p>To produce a literal asterisk or underscore at a position where it\nwould otherwise be used as an emphasis delimiter, you can backslash\nescape it:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>\\*this text is surrounded by literal asterisks\\*\n</code></pre><h3 id=\"code\">Code</h3>\n\n<p>To indicate a span of code, wrap it with backtick quotes (<code>`</code>).\nUnlike a pre-formatted code block, a code span indicates code within a\nnormal paragraph. For example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>Use the `printf()` function.\n</code></pre><p>will produce:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;Use the &lt;code&gt;printf()&lt;/code&gt; function.&lt;/p&gt;\n</code></pre><p>To include a literal backtick character within a code span, you can use\nmultiple backticks as the opening and closing delimiters:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>``There is a literal backtick (`) here.``\n</code></pre><p>which will produce this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;&lt;code&gt;There is a literal backtick (`) here.&lt;/code&gt;&lt;/p&gt;\n</code></pre><p>The backtick delimiters surrounding a code span may include spaces --\none after the opening, one before the closing. This allows you to place\nliteral backtick characters at the beginning or end of a code span:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>A single backtick in a code span: `` ` ``\n\nA backtick-delimited string in a code span: `` `foo` ``\n</code></pre><p>will produce:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;A single backtick in a code span: &lt;code&gt;`&lt;/code&gt;&lt;/p&gt;\n\n&lt;p&gt;A backtick-delimited string in a code span: &lt;code&gt;`foo`&lt;/code&gt;&lt;/p&gt;\n</code></pre><p>With a code span, ampersands and angle brackets are encoded as HTML\nentities automatically, which makes it easy to include example HTML\ntags. Markdown will turn this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>Please don't use any `&lt;blink&gt;` tags.\n</code></pre><p>into:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;Please don't use any &lt;code&gt;&amp;lt;blink&amp;gt;&lt;/code&gt; tags.&lt;/p&gt;\n</code></pre><p>You can write this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>`&amp;#8212;` is the decimal-encoded equivalent of `&amp;mdash;`.\n</code></pre><p>to produce:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;p&gt;&lt;code&gt;&amp;amp;#8212;&lt;/code&gt; is the decimal-encoded\nequivalent of &lt;code&gt;&amp;amp;mdash;&lt;/code&gt;.&lt;/p&gt;\n</code></pre><h3 id=\"img\">Images</h3>\n\n<p>Admittedly, it's fairly difficult to devise a \"natural\" syntax for\nplacing images into a plain text document format.</p>\n<p>Markdown uses an image syntax that is intended to resemble the syntax\nfor links, allowing for two styles: <em>inline</em> and <em>reference</em>.</p>\n<p>Inline image syntax looks like this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>![Alt text](/path/to/img.jpg)\n\n![Alt text](/path/to/img.jpg \"Optional title\")\n</code></pre><p>That is:</p>\n<ul>\n<li>An exclamation mark: <code>!</code>;</li>\n<li>followed by a set of square brackets, containing the <code>alt</code>\nattribute text for the image;</li>\n<li>followed by a set of parentheses, containing the URL or path to\nthe image, and an optional <code>title</code> attribute enclosed in double\nor single quotes.</li>\n</ul>\n<p>Reference-style image syntax looks like this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>![Alt text][id]\n</code></pre><p>Where \"id\" is the name of a defined image reference. Image references\nare defined using syntax identical to link references:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[id]: url/to/image  \"Optional title attribute\"\n</code></pre><p>As of this writing, Markdown has no syntax for specifying the\ndimensions of an image; if this is important to you, you can simply\nuse regular HTML <code>&lt;img&gt;</code> tags.</p>\n<hr />\n<h2 id=\"misc\">Miscellaneous</h2>\n\n<h3 id=\"autolink\">Automatic Links</h3>\n\n<p>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:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;http://example.com/&gt;\n</code></pre><p>Markdown will turn this into:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;a href=\"http://example.com/\"&gt;http://example.com/&lt;/a&gt;\n</code></pre><p>Automatic links for email addresses work similarly, except that\nMarkdown will also perform a bit of randomized decimal and hex\nentity-encoding to help obscure your address from address-harvesting\nspambots. For example, Markdown will turn this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;address@example.com&gt;\n</code></pre><p>into something like this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>&lt;a href=\"&amp;#x6D;&amp;#x61;i&amp;#x6C;&amp;#x74;&amp;#x6F;:&amp;#x61;&amp;#x64;&amp;#x64;&amp;#x72;&amp;#x65;\n&amp;#115;&amp;#115;&amp;#64;&amp;#101;&amp;#120;&amp;#x61;&amp;#109;&amp;#x70;&amp;#x6C;e&amp;#x2E;&amp;#99;&amp;#111;\n&amp;#109;\"&gt;&amp;#x61;&amp;#x64;&amp;#x64;&amp;#x72;&amp;#x65;&amp;#115;&amp;#115;&amp;#64;&amp;#101;&amp;#120;&amp;#x61;\n&amp;#109;&amp;#x70;&amp;#x6C;e&amp;#x2E;&amp;#99;&amp;#111;&amp;#109;&lt;/a&gt;\n</code></pre><p>which will render in a browser as a clickable link to \"<a href=\"mailto:address@example.com\">address@example.com</a>\".</p>\n<p>(This sort of entity-encoding trick will indeed fool many, if not\nmost, address-harvesting bots, but it definitely won't fool all of\nthem. It's better than nothing, but an address published in this way\nwill probably eventually start receiving spam.)</p>\n<h3 id=\"backslash\">Backslash Escapes</h3>\n\n<p>Markdown allows you to use backslash escapes to generate literal\ncharacters which would otherwise have special meaning in Markdown's\nformatting syntax. For example, if you wanted to surround a word\nwith literal asterisks (instead of an HTML <code>&lt;em&gt;</code> tag), you can use\nbackslashes before the asterisks, like this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>\\*literal asterisks\\*\n</code></pre><p>Markdown provides backslash escapes for the following characters:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>\\   backslash\n`   backtick\n*   asterisk\n_   underscore\n{}  curly braces\n[]  square brackets\n()  parentheses\n#   hash mark\n+   plus sign\n-   minus sign (hyphen)\n.   dot\n!   exclamation mark\n</code></pre>","_postman_id":"250c5e50-7091-1e40-9e78-efe20ab41357"}]}