diff options
Diffstat (limited to 'tests/markdown-test/markdown-syntax.html')
| -rw-r--r-- | tests/markdown-test/markdown-syntax.html | 373 |
1 files changed, 189 insertions, 184 deletions
diff --git a/tests/markdown-test/markdown-syntax.html b/tests/markdown-test/markdown-syntax.html index 84fe3bd..b3df92f 100644 --- a/tests/markdown-test/markdown-syntax.html +++ b/tests/markdown-test/markdown-syntax.html @@ -7,74 +7,74 @@ <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li> </ul></p> <ul> -<li> -<a href="#overview">Overview</a> -<ul> -<li> -<a href="#philosophy">Philosophy</a> -</li> -<li> -<a href="#html">Inline HTML</a> -</li> -<li> -<a href="#autoescape">Automatic Escaping for Special Characters</a> -</li> -</ul> -</li> -<li> -<a href="#block">Block Elements</a> -<ul> -<li> -<a href="#p">Paragraphs and Line Breaks</a> -</li> -<li> -<a href="#header">Headers</a> -</li> -<li> -<a href="#blockquote">Blockquotes</a> -</li> -<li> -<a href="#list">Lists</a> -</li> -<li> -<a href="#precode">Code Blocks</a> -</li> -<li> -<a href="#hr">Horizontal Rules</a> -</li> -</ul> -</li> -<li> -<a href="#span">Span Elements</a> -<ul> -<li> -<a href="#link">Links</a> -</li> -<li> -<a href="#em">Emphasis</a> -</li> -<li> -<a href="#code">Code</a> -</li> -<li> -<a href="#img">Images</a> -</li> -</ul> -</li> -<li> -<a href="#misc">Miscellaneous</a> -<ul> -<li> -<a href="#backslash">Backslash Escapes</a> -</li> -<li> -<a href="#autolink">Automatic Links</a> -</li> -</ul> -</li> + <li> + <a href="#overview">Overview</a> + <ul> + <li> + <a href="#philosophy">Philosophy</a> + </li> + <li> + <a href="#html">Inline HTML</a> + </li> + <li> + <a href="#autoescape">Automatic Escaping for Special Characters</a> + </li> + </ul> + </li> + <li> + <a href="#block">Block Elements</a> + <ul> + <li> + <a href="#p">Paragraphs and Line Breaks</a> + </li> + <li> + <a href="#header">Headers</a> + </li> + <li> + <a href="#blockquote">Blockquotes</a> + </li> + <li> + <a href="#list">Lists</a> + </li> + <li> + <a href="#precode">Code Blocks</a> + </li> + <li> + <a href="#hr">Horizontal Rules</a> + </li> + </ul> + </li> + <li> + <a href="#span">Span Elements</a> + <ul> + <li> + <a href="#link">Links</a> + </li> + <li> + <a href="#em">Emphasis</a> + </li> + <li> + <a href="#code">Code</a> + </li> + <li> + <a href="#img">Images</a> + </li> + </ul> + </li> + <li> + <a href="#misc">Miscellaneous</a> + <ul> + <li> + <a href="#backslash">Backslash Escapes</a> + </li> + <li> + <a href="#autolink">Automatic Links</a> + </li> + </ul> + </li> </ul> <p> -<strong>Note:</strong> This document is itself written using Markdown; you + <strong>Note:</strong> This document is itself written using Markdown; you can <a href="/projects/markdown/syntax.text">see the source for it by adding '.text' to the URL</a>.</p> <hr /> <p><h2 id="overview">Overview</h2></p> @@ -85,7 +85,7 @@ 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 <a href="http://docutils.sourceforge.net/mirror/setext.html">Setext</a>, <a href="http://www.aaronsw.com/2002/atx/">atx</a>, <a href="http://textism.com/tools/textile/">Textile</a>, <a href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>, -<a href="http://www.triptico.com/software/grutatxt.html">Grutatext</a>, and <a href="http://ettext.taint.org/doc/">EtText</a>-- the single biggest source of +<a href="http://www.triptico.com/software/grutatxt.html">Grutatext</a>, and <a href="http://ettext.taint.org/doc/">EtText</a> -- the single biggest source of inspiration for Markdown's syntax is the format of plain text email.</p> <p>To this end, Markdown's syntax is comprised entirely of punctuation characters, which punctuation characters have been carefully chosen so @@ -95,13 +95,14 @@ blockquotes look like quoted passages of text, assuming you've ever used email.</p> <p><h3 id="html">Inline HTML</h3></p> <p>Markdown's syntax is intended for one purpose: to be used as a -format for <em>writing</em>for the web.</p> +format for <em>writing</em> for the web.</p> <p>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 <em>not</em> 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 <em>publishing</em> format; Markdown is a <em>writing</em>format. Thus, Markdown's formatting syntax only addresses issues that +edit prose. HTML is a <em>publishing</em> format; Markdown is a <em>writing</em> +format. Thus, Markdown's formatting syntax only addresses issues that can be conveyed in plain text.</p> <p>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 @@ -111,10 +112,10 @@ the tags.</p> <code><table></code>, <code><pre></code>, <code><p></code>, 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) <code><p></code>tags around HTML block-level tags.</p> +to add extra (unwanted) <code><p></code> tags around HTML block-level tags.</p> <p>For example, to add an HTML table to a Markdown article:</p> <pre> -<code>This is a regular paragraph. + <code>This is a regular paragraph. <table> <tr> @@ -126,14 +127,14 @@ This is another regular paragraph. </code> </pre> <p>Note that Markdown formatting syntax is not processed within block-level -HTML tags. E.g., you can't use Markdown-style <code>*emphasis*</code>inside an +HTML tags. E.g., you can't use Markdown-style <code>*emphasis*</code> inside an HTML block.</p> <p>Span-level HTML tags -- e.g. <code><span></code>, <code><cite></code>, or <code><del></code> -- 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 <code><a></code> or <code><img></code>tags instead of Markdown's +you'd prefer to use HTML <code><a></code> or <code><img></code> tags instead of Markdown's link or image syntax, go right ahead.</p> -<p>Unlike block-level HTML tags, Markdown syntax <em>is</em>processed within +<p>Unlike block-level HTML tags, Markdown syntax <em>is</em> processed within span-level tags.</p> <p><h3 id="autoescape">Automatic Escaping for Special Characters</h3></p> <p>In HTML, there are two characters that demand special treatment: <code><</code> @@ -145,15 +146,15 @@ characters, you must escape them as entities, e.g. <code>&lt;</code>, and write about 'AT&T', you need to write '<code>AT&amp;T</code>'. You even need to escape ampersands within URLs. Thus, if you want to link to:</p> <pre> -<code>http://images.google.com/images?num=30&q=larry+bird + <code>http://images.google.com/images?num=30&q=larry+bird </code> </pre> <p>you need to encode the URL as:</p> <pre> -<code>http://images.google.com/images?num=30&amp;q=larry+bird + <code>http://images.google.com/images?num=30&amp;q=larry+bird </code> </pre> -<p>in your anchor tag <code>href</code>attribute. Needless to say, this is easy to +<p>in your anchor tag <code>href</code> 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.</p> <p>Markdown allows you to use these characters naturally, taking care of @@ -162,36 +163,36 @@ an HTML entity, it remains unchanged; otherwise it will be translated into <code>&amp;</code>.</p> <p>So, if you want to include a copyright symbol in your article, you can write:</p> <pre> -<code>&copy; + <code>&copy; </code> </pre> <p>and Markdown will leave it alone. But if you write:</p> <pre> -<code>AT&T + <code>AT&T </code> </pre> <p>Markdown will translate it to:</p> <pre> -<code>AT&amp;T + <code>AT&amp;T </code> </pre> <p>Similarly, because Markdown supports <a href="#html">inline HTML</a>, if you use angle brackets as delimiters for HTML tags, Markdown will treat them as such. But if you write:</p> <pre> -<code>4 < 5 + <code>4 < 5 </code> </pre> <p>Markdown will translate it to:</p> <pre> -<code>4 &lt; 5 + <code>4 &lt; 5 </code> </pre> <p>However, inside Markdown code spans and blocks, angle brackets and ampersands are <em>always</em> 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 <code><</code> -and <code>&</code>in your example code needs to be escaped.)</p> +and <code>&</code> in your example code needs to be escaped.)</p> <hr /> <p><h2 id="block">Block Elements</h2></p> <p><h3 id="p">Paragraphs and Line Breaks</h3></p> @@ -203,18 +204,19 @@ blank.) Normal paragraphs should not be intended with spaces or tabs.</p> that Markdown supports "hard-wrapped" text paragraphs. This differs significantly from most other text-to-HTML formatters (including Movable Type's "Convert Line Breaks" option) which translate every line break -character in a paragraph into a <code><br /></code>tag.</p> -<p>When you <em>do</em> want to insert a <code><br /></code>break tag using Markdown, you +character in a paragraph into a <code><br /></code> tag.</p> +<p>When you <em>do</em> want to insert a <code><br /></code> break tag using Markdown, you end a line with two or more spaces, then type return.</p> <p>Yes, this takes a tad more effort to create a <code><br /></code>, but a simplistic "every line break is a <code><br /></code>" rule wouldn't work for Markdown. -Markdown's email-style <a href="#blockquote">blockquoting</a> and multi-paragraph <a href="#list">list items</a>work best -- and look better -- when you format them with hard breaks.</p> +Markdown's email-style <a href="#blockquote">blockquoting</a> and multi-paragraph <a href="#list">list items</a> +work best -- and look better -- when you format them with hard breaks.</p> <p><h3 id="header">Headers</h3></p> -<p>Markdown supports two styles of headers, <a href="http://docutils.sourceforge.net/mirror/setext.html">Setext</a>and <a href="http://www.aaronsw.com/2002/atx/">atx</a>.</p> +<p>Markdown supports two styles of headers, <a href="http://docutils.sourceforge.net/mirror/setext.html">Setext</a> and <a href="http://www.aaronsw.com/2002/atx/">atx</a>.</p> <p>Setext-style headers are "underlined" using equal signs (for first-level headers) and dashes (for second-level headers). For example:</p> <pre> -<code>This is an H1 + <code>This is an H1 ============= This is an H2 @@ -225,7 +227,7 @@ This is an H2 <p>Atx-style headers use 1-6 hash characters at the start of the line, corresponding to header levels 1-6. For example:</p> <pre> -<code># This is an H1 + <code># This is an H1 ## This is an H2 @@ -238,7 +240,7 @@ 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.) :</p> <pre> -<code># This is an H1 # + <code># This is an H1 # ## This is an H2 ## @@ -249,9 +251,9 @@ determines the header level.) :</p> <p>Markdown uses email-style <code>></code> 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 <code>></code>before every line:</p> +wrap the text and put a <code>></code> before every line:</p> <pre> -<code>> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet, + <code>> 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. > @@ -259,10 +261,10 @@ wrap the text and put a <code>></code>before every line:</p> > id sem consectetuer libero luctus adipiscing. </code> </pre> -<p>Markdown allows you to be lazy and only put the <code>></code>before the first +<p>Markdown allows you to be lazy and only put the <code>></code> before the first line of a hard-wrapped paragraph:</p> <pre> -<code>> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet, + <code>> 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. @@ -273,7 +275,7 @@ id sem consectetuer libero luctus adipiscing. <p>Blockquotes can be nested (i.e. a blockquote-in-a-blockquote) by adding additional levels of <code>></code>:</p> <pre> -<code>> This is the first level of quoting. + <code>> This is the first level of quoting. > > > This is nested blockquote. > @@ -283,7 +285,7 @@ adding additional levels of <code>></code>:</p> <p>Blockquotes can contain other Markdown elements, including headers, lists, and code blocks:</p> <pre> -<code>> ## This is a header. + <code>> ## This is a header. > > 1. This is the first list item. > 2. This is the second list item. @@ -301,28 +303,28 @@ Quote Level from the Text menu.</p> <p>Unordered lists use asterisks, pluses, and hyphens -- interchangably -- as list markers:</p> <pre> -<code>* Red + <code>* Red * Green * Blue </code> </pre> <p>is equivalent to:</p> <pre> -<code>+ Red + <code>+ Red + Green + Blue </code> </pre> <p>and:</p> <pre> -<code>- Red + <code>- Red - Green - Blue </code> </pre> <p>Ordered lists use numbers followed by periods:</p> <pre> -<code>1. Bird + <code>1. Bird 2. McHale 3. Parish </code> @@ -331,7 +333,7 @@ Quote Level from the Text menu.</p> list have no effect on the HTML output Markdown produces. The HTML Markdown produces from the above list is:</p> <pre> -<code><ol> + <code><ol> <li>Bird</li> <li>McHale</li> <li>Parish</li> @@ -340,14 +342,14 @@ Markdown produces from the above list is:</p> </pre> <p>If you instead wrote the list in Markdown like this:</p> <pre> -<code>1. Bird + <code>1. Bird 1. McHale 1. Parish </code> </pre> <p>or even:</p> <pre> -<code>3. Bird + <code>3. Bird 1. McHale 8. Parish </code> @@ -364,7 +366,7 @@ up to three spaces. List markers must be followed by one or more spaces or a tab.</p> <p>To make lists look nice, you can wrap items with hanging indents:</p> <pre> -<code>* Lorem ipsum dolor sit amet, consectetuer adipiscing elit. + <code>* 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. @@ -373,7 +375,7 @@ or a tab.</p> </pre> <p>But if you want to be lazy, you don't have to:</p> <pre> -<code>* Lorem ipsum dolor sit amet, consectetuer adipiscing elit. + <code>* 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. @@ -381,15 +383,15 @@ Suspendisse id sem consectetuer libero luctus adipiscing. </code> </pre> <p>If list items are separated by blank lines, Markdown will wrap the -items in <code><p></code>tags in the HTML output. For example, this input:</p> +items in <code><p></code> tags in the HTML output. For example, this input:</p> <pre> -<code>* Bird + <code>* Bird * Magic </code> </pre> <p>will turn into:</p> <pre> -<code><ul> + <code><ul> <li>Bird</li> <li>Magic</li> </ul> @@ -397,14 +399,14 @@ items in <code><p></code>tags in the HTML output. For example, this input: </pre> <p>But this:</p> <pre> -<code>* Bird + <code>* Bird * Magic </code> </pre> <p>will turn into:</p> <pre> -<code><ul> + <code><ul> <li><p>Bird</p></li> <li><p>Magic</p></li> </ul> @@ -414,7 +416,7 @@ items in <code><p></code>tags in the HTML output. For example, this input: paragraph in a list item must be intended by either 4 spaces or one tab:</p> <pre> -<code>1. This is a list item with two paragraphs. Lorem ipsum dolor + <code>1. This is a list item with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. @@ -429,7 +431,7 @@ or one tab:</p> paragraphs, but here again, Markdown will allow you to be lazy:</p> <pre> -<code>* This is a list item with two paragraphs. + <code>* 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 @@ -438,19 +440,19 @@ sit amet, consectetuer adipiscing elit. * Another item in the same list. </code> </pre> -<p>To put a blockquote within a list item, the blockquote's -<code>></code>delimiters need to be indented:</p> +<p>To put a blockquote within a list item, the blockquote's <code>></code> +delimiters need to be indented:</p> <pre> -<code>* A list item with a blockquote: + <code>* A list item with a blockquote: > This is a blockquote > inside a list item. </code> </pre> <p>To put a code block within a list item, the code block needs -to be indented <em>twice</em>-- 8 spaces or two tabs:</p> +to be indented <em>twice</em> -- 8 spaces or two tabs:</p> <pre> -<code>* A list item with a code block: + <code>* A list item with a code block: <code goes here> </code> @@ -458,31 +460,31 @@ to be indented <em>twice</em>-- 8 spaces or two tabs:</p> <p>It's worth noting that it's possible to trigger an ordered list by accident, by writing something like this:</p> <pre> -<code>1986. What a great season. + <code>1986. What a great season. </code> </pre> -<p>In other words, a <em>number-period-space</em>sequence at the beginning of a +<p>In other words, a <em>number-period-space</em> sequence at the beginning of a line. To avoid this, you can backslash-escape the period:</p> <pre> -<code>1986\. What a great season. + <code>1986\. What a great season. </code> </pre> <p><h3 id="precode">Code Blocks</h3></p> <p>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 <code><pre></code> and <code><code></code>tags.</p> +in both <code><pre></code> and <code><code></code> tags.</p> <p>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:</p> <pre> -<code>This is a normal paragraph: + <code>This is a normal paragraph: This is a code block. </code> </pre> <p>Markdown will generate:</p> <pre> -<code><p>This is a normal paragraph:</p> + <code><p>This is a normal paragraph:</p> <pre><code>This is a code block. </code></pre> @@ -491,7 +493,7 @@ block by at least 4 spaces or 1 tab. For example, given this input:</p> <p>One level of indentation -- 4 spaces or 1 tab -- is removed from each line of the code block. For example, this:</p> <pre> -<code>Here is an example of AppleScript: + <code>Here is an example of AppleScript: tell application "Foo" beep @@ -500,7 +502,7 @@ line of the code block. For example, this:</p> </pre> <p>will turn into:</p> <pre> -<code><p>Here is an example of AppleScript:</p> + <code><p>Here is an example of AppleScript:</p> <pre><code>tell application "Foo" beep @@ -516,14 +518,14 @@ 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:</p> <pre> -<code> <div class="footer"> + <code> <div class="footer"> &copy; 2004 Foo Corporation </div> </code> </pre> <p>will turn into:</p> <pre> -<code><pre><code>&lt;div class="footer"&gt; + <code><pre><code>&lt;div class="footer"&gt; &amp;copy; 2004 Foo Corporation &lt;/div&gt; </code></pre> @@ -538,7 +540,7 @@ 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:</p> <pre> -<code>* * * + <code>* * * *** @@ -558,16 +560,17 @@ _ _ _ <p>In both styles, the link text is delimited by [square brackets].</p> <p>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 <em>optional</em>title for the link, surrounded in quotes. For example:</p> +put the URL where you want the link to point, along with an <em>optional</em> +title for the link, surrounded in quotes. For example:</p> <pre> -<code>This is [an example](http://example.com/ "Title") inline link. + <code>This is [an example](http://example.com/ "Title") inline link. [This link](http://example.net/) has no title attribute. </code> </pre> <p>Will produce:</p> <pre> -<code><p>This is <a href="http://example.com/" title="Title"> + <code><p>This is <a href="http://example.com/" title="Title"> an example</a> inline link.</p> <p><a href="http://example.net/">This link</a> has no @@ -577,79 +580,79 @@ title attribute.</p> <p>If you're referring to a local resource on the same server, you can use relative paths:</p> <pre> -<code>See my [About](/about/) page for details. + <code>See my [About](/about/) page for details. </code> </pre> <p>Reference-style links use a second set of square brackets, inside which you place a label of your choosing to identify the link:</p> <pre> -<code>This is [an example][id] reference-style link. + <code>This is [an example][id] reference-style link. </code> </pre> <p>You can optionally use a space to separate the sets of brackets:</p> <pre> -<code>This is [an example] [id] reference-style link. + <code>This is [an example] [id] reference-style link. </code> </pre> <p>Then, anywhere in the document, you define your link label like this, on a line by itself:</p> <pre> -<code>[id]: http://example.com/ "Optional Title Here" + <code>[id]: http://example.com/ "Optional Title Here" </code> </pre> <p>That is:</p> <ul> -<li>Square brackets containing the link identifier (optionally + <li>Square brackets containing the link identifier (optionally indented from the left margin using up to three spaces);</li> -<li>followed by a colon;</li> -<li>followed by one or more spaces (or tabs);</li> -<li>followed by the URL for the link;</li> -<li>optionally followed by a title attribute for the link, enclosed + <li>followed by a colon;</li> + <li>followed by one or more spaces (or tabs);</li> + <li>followed by the URL for the link;</li> + <li>optionally followed by a title attribute for the link, enclosed in double or single quotes.</li> </ul> <p>The link URL may, optionally, be surrounded by angle brackets:</p> <pre> -<code>[id]: <http://example.com/> "Optional Title Here" + <code>[id]: <http://example.com/> "Optional Title Here" </code> </pre> <p>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:</p> <pre> -<code>[id]: http://example.com/longish/path/to/resource/here + <code>[id]: http://example.com/longish/path/to/resource/here "Optional Title Here" </code> </pre> <p>Link definitions are only used for creating links during Markdown processing, and are stripped from your document in the HTML output.</p> -<p>Link definition names may constist of letters, numbers, spaces, and punctuation -- but they are <em>not</em>case sensitive. E.g. these two links:</p> +<p>Link definition names may constist of letters, numbers, spaces, and punctuation -- but they are <em>not</em> case sensitive. E.g. these two links:</p> <pre> -<code>[link text][a] + <code>[link text][a] [link text][A] </code> </pre> <p>are equivalent.</p> -<p>The <em>implicit link name</em>shortcut allows you to omit the name of the +<p>The <em>implicit link name</em> 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 google.com web site, you could simply write:</p> <pre> -<code>[Google][] + <code>[Google][] </code> </pre> <p>And then define the link:</p> <pre> -<code>[Google]: http://google.com/ + <code>[Google]: http://google.com/ </code> </pre> <p>Because link names may contain spaces, this shortcut even works for multiple words in the link text:</p> <pre> -<code>Visit [Daring Fireball][] for more information. + <code>Visit [Daring Fireball][] for more information. </code> </pre> <p>And then define the link:</p> <pre> -<code>[Daring Fireball]: http://daringfireball.net/ + <code>[Daring Fireball]: http://daringfireball.net/ </code> </pre> <p>Link definitions can be placed anywhere in your Markdown document. I @@ -658,7 +661,7 @@ used, but if you want, you can put them all at the end of your document, sort of like footnotes.</p> <p>Here's an example of reference links in action:</p> <pre> -<code>I get 10 times more traffic from [Google] [1] than from + <code>I get 10 times more traffic from [Google] [1] than from [Yahoo] [2] or [MSN] [3]. [1]: http://google.com/ "Google" @@ -668,7 +671,7 @@ document, sort of like footnotes.</p> </pre> <p>Using the implicit link name shortcut, you could instead write:</p> <pre> -<code>I get 10 times more traffic from [Google][] than from + <code>I get 10 times more traffic from [Google][] than from [Yahoo][] or [MSN][]. [google]: http://google.com/ "Google" @@ -678,7 +681,7 @@ document, sort of like footnotes.</p> </pre> <p>Both of the above examples will produce the following HTML output:</p> <pre> -<code><p>I get 10 times more traffic from <a href="http://google.com/" + <code><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> @@ -687,7 +690,7 @@ or <a href="http://search.msn.com/" title="MSN Search">MSN</a>.</ <p>For comparison, here is the same paragraph written using Markdown's inline link style:</p> <pre> -<code>I get 10 times more traffic from [Google](http://google.com/ "Google") + <code>I get 10 times more traffic from [Google](http://google.com/ "Google") than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or [MSN](http://search.msn.com/ "MSN Search"). </code> @@ -708,9 +711,9 @@ prose.</p> <p>Markdown treats asterisks (<code>*</code>) and underscores (<code>_</code>) as indicators of emphasis. Text wrapped with one <code>*</code> or <code>_</code> will be wrapped with an HTML <code><em></code> tag; double <code>*</code>'s or <code>_</code>'s will be wrapped with an HTML -<code><strong></code>tag. E.g., this input:</p> +<code><strong></code> tag. E.g., this input:</p> <pre> -<code>*single asterisks* + <code>*single asterisks* _single underscores_ @@ -721,7 +724,7 @@ __double underscores__ </pre> <p>will produce:</p> <pre> -<code><em>single asterisks</em> + <code><em>single asterisks</em> <em>single underscores</em> @@ -734,16 +737,16 @@ __double underscores__ the same character must be used to open and close an emphasis span.</p> <p>Emphasis can be used in the middle of a word:</p> <pre> -<code>un*fucking*believable + <code>un*fucking*believable </code> </pre> -<p>But if you surround an <code>*</code> or <code>_</code>with spaces, it'll be treated as a +<p>But if you surround an <code>*</code> or <code>_</code> with spaces, it'll be treated as a literal asterisk or underscore.</p> <p>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:</p> <pre> -<code>\*this text is surrounded by literal asterisks\* + <code>\*this text is surrounded by literal asterisks\* </code> </pre> <p><h3 id="code">Code</h3></p> @@ -751,37 +754,37 @@ escape it:</p> Unlike a pre-formatted code block, a code span indicates code within a normal paragraph. For example:</p> <pre> -<code>Use the `printf()` function. + <code>Use the `printf()` function. </code> </pre> <p>will produce:</p> <pre> -<code><p>Use the <code>printf()</code> function.</p> + <code><p>Use the <code>printf()</code> function.</p> </code> </pre> <p>To include a literal backtick character within a code span, you can use multiple backticks as the opening and closing delimiters:</p> <pre> -<code>``There is a literal backtick (`) here.`` + <code>``There is a literal backtick (`) here.`` </code> </pre> <p>which will produce this:</p> <pre> -<code><p><code>There is a literal backtick (`) here.</code></p> + <code><p><code>There is a literal backtick (`) here.</code></p> </code> </pre> <p>The backtick delimiters surrounding a code span may include spaces -- one after the opening, one before the closing. This allows you to place literal backtick characters at the beginning or end of a code span:</p> <pre> -<code>A single backtick in a code span: `` ` `` + <code>A single backtick in a code span: `` ` `` A backtick-delimited string in a code span: `` `foo` `` </code> </pre> <p>will produce:</p> <pre> -<code><p>A single backtick in a code span: <code>`</code></p> + <code><p>A single backtick in a code span: <code>`</code></p> <p>A backtick-delimited string in a code span: <code>`foo`</code></p> </code> @@ -790,22 +793,22 @@ A backtick-delimited string in a code span: `` `foo` `` entities automatically, which makes it easy to include example HTML tags. Markdown will turn this:</p> <pre> -<code>Please don't use any `<blink>` tags. + <code>Please don't use any `<blink>` tags. </code> </pre> <p>into:</p> <pre> -<code><p>Please don't use any <code>&lt;blink&gt;</code> tags.</p> + <code><p>Please don't use any <code>&lt;blink&gt;</code> tags.</p> </code> </pre> <p>You can write this:</p> <pre> -<code>`&#8212;` is the decimal-encoded equivalent of `&mdash;`. + <code>`&#8212;` is the decimal-encoded equivalent of `&mdash;`. </code> </pre> <p>to produce:</p> <pre> -<code><p><code>&amp;#8212;</code> is the decimal-encoded + <code><p><code>&amp;#8212;</code> is the decimal-encoded equivalent of <code>&amp;mdash;</code>.</p> </code> </pre> @@ -816,44 +819,45 @@ placing images into a plain text document format.</p> for links, allowing for two styles: <em>inline</em> and <em>reference</em>.</p> <p>Inline image syntax looks like this:</p> <pre> -<code> + <code>  </code> </pre> <p>That is:</p> <ul> -<li>An exclamation mark: <code>!</code>;</li> -<li>followed by a set of square brackets, containing the <code>alt</code>attribute text for the image;</li> -<li>followed by a set of parentheses, containing the URL or path to -the image, and an optional <code>title</code>attribute enclosed in double + <li>An exclamation mark: <code>!</code>;</li> + <li>followed by a set of square brackets, containing the <code>alt</code> +attribute text for the image;</li> + <li>followed by a set of parentheses, containing the URL or path to +the image, and an optional <code>title</code> attribute enclosed in double or single quotes.</li> </ul> <p>Reference-style image syntax looks like this:</p> <pre> -<code>![Alt text][id] + <code>![Alt text][id] </code> </pre> <p>Where "id" is the name of a defined image reference. Image references are defined using syntax identical to link references:</p> <pre> -<code>[id]: url/to/image "Optional title attribute" + <code>[id]: url/to/image "Optional title attribute" </code> </pre> <p>As of this writing, Markdown has no syntax for specifying the dimensions of an image; if this is important to you, you can simply -use regular HTML <code><img></code>tags.</p> +use regular HTML <code><img></code> tags.</p> <hr /> <p><h2 id="misc">Miscellaneous</h2></p> <p><h3 id="autolink">Automatic Links</h3></p> <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> <pre> -<code><http://example.com/> + <code><http://example.com/> </code> </pre> <p>Markdown will turn this into:</p> <pre> -<code><a href="http://example.com/">http://example.com/</a> + <code><a href="http://example.com/">http://example.com/</a> </code> </pre> <p>Automatic links for email addresses work similarly, except that @@ -861,12 +865,12 @@ Markdown will also perform a bit of randomized decimal and hex entity-encoding to help obscure your address from address-harvesting spambots. For example, Markdown will turn this:</p> <pre> -<code><address@example.com> + <code><address@example.com> </code> </pre> <p>into something like this:</p> <pre> -<code><a href="&#x6D;&#x61;i&#x6C;&#x74;&#x6F;:&#x61;&#x64;&#x64;&#x72;&#x65; + <code><a href="&#x6D;&#x61;i&#x6C;&#x74;&#x6F;:&#x61;&#x64;&#x64;&#x72;&#x65; &#115;&#115;&#64;&#101;&#120;&#x61;&#109;&#x70;&#x6C;e&#x2E;&#99;&#111; &#109;">&#x61;&#x64;&#x64;&#x72;&#x65;&#115;&#115;&#64;&#101;&#120;&#x61; &#109;&#x70;&#x6C;e&#x2E;&#99;&#111;&#109;</a> @@ -881,15 +885,15 @@ will probably eventually start receiving spam.)</p> <p>Markdown allows you to use backslash escapes to generate literal characters which would otherwise have special meaning in Markdown's formatting syntax. For example, if you wanted to surround a word with -literal asterisks (instead of an HTML <code><em></code>tag), you can backslashes +literal asterisks (instead of an HTML <code><em></code> tag), you can backslashes before the asterisks, like this:</p> <pre> -<code>\*literal asterisks\* + <code>\*literal asterisks\* </code> </pre> <p>Markdown provides backslash escapes for the following characters:</p> <pre> -<code>\ backslash + <code>\ backslash ` backtick * asterisk _ underscore @@ -903,3 +907,4 @@ _ underscore ! exclamation mark </code> </pre> + |