diff options
Diffstat (limited to 'tests/markdown-test/markdown-syntax.html')
| -rw-r--r-- | tests/markdown-test/markdown-syntax.html | 85 |
1 files changed, 41 insertions, 44 deletions
diff --git a/tests/markdown-test/markdown-syntax.html b/tests/markdown-test/markdown-syntax.html index a0440e4..c789d95 100644 --- a/tests/markdown-test/markdown-syntax.html +++ b/tests/markdown-test/markdown-syntax.html @@ -1,5 +1,3 @@ - - <h1>Markdown: Syntax</h1> <ul id="ProjectSubmenu"> <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li> @@ -224,17 +222,17 @@ This is another regular paragraph. blank line -- a line containing nothing but spaces or tabs is considered blank.) Normal paragraphs should not be intended with spaces or tabs. </p> -<p>The implication of the "one or more consecutive lines of text" rule is - that Markdown supports "hard-wrapped" text paragraphs. This differs +<p>The implication of the "one or more consecutive lines of text" rule is + 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 + 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 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. + "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> @@ -242,7 +240,7 @@ This is another regular paragraph. <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 +<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 @@ -260,7 +258,7 @@ This is an H2 ## This is an H2 ###### This is an H6 -</code></pre><p>Optionally, you may "close" atx-style headers. This is purely +</code></pre><p>Optionally, you may "close" atx-style headers. This is purely cosmetic -- you can use this if you think it looks better. The closing hashes don't even need to match the number of hashes used to open the header. (The number of opening hashes @@ -311,7 +309,7 @@ id sem consectetuer libero luctus adipiscing. > > Here's some example code: > -> return shell_exec("echo $input | $markdown_script"); +> return shell_exec("echo $input | $markdown_script"); </code></pre><p>Any decent text editor should make email-style quoting easy. For example, with BBEdit, you can make a selection and choose Increase Quote Level from the Text menu. @@ -478,14 +476,14 @@ sit amet, consectetuer adipiscing elit. </p> <pre><code>Here is an example of AppleScript: - tell application "Foo" + tell application "Foo" beep end tell </code></pre><p>will turn into: </p> <pre><code><p>Here is an example of AppleScript:</p> -<pre><code>tell application "Foo" +<pre><code>tell application "Foo" beep end tell </code></pre> @@ -498,12 +496,12 @@ end tell 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"> +<pre><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; +<pre><code><pre><code>&lt;div class="footer"&gt; &amp;copy; 2004 Foo Corporation &lt;/div&gt; </code></pre> @@ -544,15 +542,15 @@ _ _ _ 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. +<pre><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"> +<pre><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 +<p><a href="http://example.net/">This link</a> has no title attribute.</p> </code></pre><p>If you're referring to a local resource on the same server, you can use relative paths: @@ -568,7 +566,7 @@ title attribute.</p> </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" +<pre><code>[id]: http://example.com/ "Optional Title Here" </code></pre><p>That is: </p> <ul> @@ -596,12 +594,12 @@ title attribute.</p> </ul> <p>The link URL may, optionally, be surrounded by angle brackets: </p> -<pre><code>[id]: <http://example.com/> "Optional Title Here" +<pre><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 - "Optional Title 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> @@ -614,7 +612,7 @@ title attribute.</p> <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: + "Google" to the google.com web site, you could simply write: </p> <pre><code>[Google][] </code></pre><p>And then define the link: @@ -637,29 +635,29 @@ title attribute.</p> <pre><code>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" + [1]: http://google.com/ "Google" + [2]: http://search.yahoo.com/ "Yahoo Search" + [3]: http://search.msn.com/ "MSN Search" </code></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 [Yahoo][] or [MSN][]. - [google]: http://google.com/ "Google" - [yahoo]: http://search.yahoo.com/ "Yahoo Search" - [msn]: http://search.msn.com/ "MSN Search" + [google]: http://google.com/ "Google" + [yahoo]: http://search.yahoo.com/ "Yahoo Search" + [msn]: http://search.msn.com/ "MSN Search" </code></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/" -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> +<pre><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> </code></pre><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") -than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or -[MSN](http://search.msn.com/ "MSN Search"). +<pre><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></pre><p>The point of reference-style links is not that they're easier to write. The point is that with reference-style links, your document source is vastly more readable. Compare the above examples: using @@ -757,7 +755,7 @@ A backtick-delimited string in a code span: `` `foo` `` equivalent of <code>&amp;mdash;</code>.</p> </code></pre><h3 id="img">Images</h3> -<p>Admittedly, it's fairly difficult to devise a "natural" syntax for +<p>Admittedly, it's fairly difficult to devise a "natural" syntax for placing images into a plain text document format. </p> <p>Markdown uses an image syntax that is intended to resemble the syntax @@ -767,7 +765,7 @@ equivalent of <code>&amp;mdash;</code>.</p> </p> <pre><code> - + </code></pre><p>That is: </p> <ul> @@ -789,10 +787,10 @@ or single quotes. <p>Reference-style image syntax looks like this: </p> <pre><code>![Alt text][id] -</code></pre><p>Where "id" is the name of a defined image reference. Image references +</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" +<pre><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. @@ -803,12 +801,12 @@ or single quotes. <h3 id="autolink">Automatic Links</h3> -<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>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></pre><p>Markdown will turn this into: </p> -<pre><code><a href="http://example.com/">http://example.com/</a> +<pre><code><a href="http://example.com/">http://example.com/</a> </code></pre><p>Automatic links for email addresses work similarly, except that Markdown will also perform a bit of randomized decimal and hex entity-encoding to help obscure your address from address-harvesting @@ -817,11 +815,11 @@ or single quotes. <pre><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; +<pre><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;">&#x61;&#x64;&#x64;&#x72;&#x65;&#115;&#115;&#64;&#101;&#120;&#x61; &#109;&#x70;&#x6C;e&#x2E;&#99;&#111;&#109;</a> -</code></pre><p>which will render in a browser as a clickable link to "address@example.com". +</code></pre><p>which will render in a browser as a clickable link to "address@example.com". </p> <p>(This sort of entity-encoding trick will indeed fool many, if not most, address-harvesting bots, but it definitely won't fool all of @@ -851,5 +849,4 @@ _ underscore - minus sign (hyphen) . dot ! exclamation mark -</code></pre> - +</code></pre>
\ No newline at end of file |