From fa014ac7743836db611713ca630a4919e8d5fa3d Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Fri, 22 Aug 2008 23:38:39 -0400 Subject: Fixed Ticket 11. Disabled ``indenteTree`` for `pre` and `code` tags. Now whitespace is preserved in codeblocks. As a side-benefit, this also solved the issue with the safe-mode tests failing. All tests incorectly altered at ElementTree conversion have been corrected for this bug. Any remaining tests that fail are unrelated to this. --- markdown.py | 2 +- tests/markdown-test/auto-links.html | 20 +- tests/markdown-test/backlash-escapes.html | 6 +- .../blockquotes-with-code-blocks.html | 16 +- tests/markdown-test/horizontal-rules.html | 36 +- tests/markdown-test/inline-html-simple.html | 24 +- tests/markdown-test/links-reference.html | 6 +- .../markdown-documentation-basics.html | 162 +++---- tests/markdown-test/markdown-syntax.html | 486 +++++++-------------- tests/markdown-test/tabs.html | 30 +- tests/misc/arabic.html | 15 +- tests/misc/bidi.html | 15 +- tests/misc/blockquote.html | 9 +- tests/misc/br.html | 6 +- tests/misc/code-first-line.html | 6 +- tests/misc/multi-test.html | 9 +- tests/misc/some-test.html | 84 ++-- tests/safe_mode/inline-html-simple.html | 24 +- 18 files changed, 337 insertions(+), 619 deletions(-) diff --git a/markdown.py b/markdown.py index 09cfdea..5d7dc32 100755 --- a/markdown.py +++ b/markdown.py @@ -106,7 +106,7 @@ def indentETree(elem, level=0): else: i = "\n" - if len(elem): + if len(elem) and elem.tag not in ['code', 'pre']: if not elem.text or not elem.text.strip(): elem.text = i + " " for e in elem: diff --git a/tests/markdown-test/auto-links.html b/tests/markdown-test/auto-links.html index 100db34..913e1a4 100644 --- a/tests/markdown-test/auto-links.html +++ b/tests/markdown-test/auto-links.html @@ -6,19 +6,17 @@

With an ampersand: http://example.com/?foo=1&bar=2

-

Blockquoted: http://example.com/ -

+

Blockquoted: http://example.com/ +

Auto-links should not occur here: <http://example.com/>

-
-or here: <http://example.com/>
-
-
\ No newline at end of file +
or here: <http://example.com/>
+
\ No newline at end of file diff --git a/tests/markdown-test/backlash-escapes.html b/tests/markdown-test/backlash-escapes.html index f99082a..18a67cc 100644 --- a/tests/markdown-test/backlash-escapes.html +++ b/tests/markdown-test/backlash-escapes.html @@ -16,8 +16,7 @@

Plus: +

Minus: -

These should not, because they occur within a code block:

-
-Backslash: \\
+
Backslash: \\
 
 Backtick: \`
 
@@ -48,8 +47,7 @@ Bang: \!
 Plus: \+
 
 Minus: \-
-
-

+

Nor should these, which occur in code spans:

Backslash: \\

diff --git a/tests/markdown-test/blockquotes-with-code-blocks.html b/tests/markdown-test/blockquotes-with-code-blocks.html index e7c79d9..4b09449 100644 --- a/tests/markdown-test/blockquotes-with-code-blocks.html +++ b/tests/markdown-test/blockquotes-with-code-blocks.html @@ -1,16 +1,12 @@
-

Example:

-
-sub status {
+  
Example:

+  
sub status {
     print "working";
 }
-
-

-
Or:

-
-sub status {
+

+  
Or:

+  
sub status {
     return "working";
 }
-
-

+
\ No newline at end of file diff --git a/tests/markdown-test/horizontal-rules.html b/tests/markdown-test/horizontal-rules.html index 98c9c90..478e8c5 100644 --- a/tests/markdown-test/horizontal-rules.html +++ b/tests/markdown-test/horizontal-rules.html @@ -3,49 +3,37 @@
-
----
-
-
+
---
+
-
-- - -
-
-
+
- - -
+

Asterisks:

-
-***
-
-
+
***
+
-
-* * *
-
-
+
* * *
+

Underscores:

-
-___
-
-
+
___
+
-
-_ _ _
-
-
+
_ _ _
+
\ No newline at end of file diff --git a/tests/markdown-test/inline-html-simple.html b/tests/markdown-test/inline-html-simple.html index df98803..cb10451 100644 --- a/tests/markdown-test/inline-html-simple.html +++ b/tests/markdown-test/inline-html-simple.html @@ -4,17 +4,13 @@

This should be a code block, though:

-
-  <div>
+
<div>
     foo
 </div>
-
-

+

As should this:

-
-  <div>foo</div>
-
-
+
<div>foo</div>
+

Now, nested:

@@ -34,18 +30,14 @@ Blah -->

Code block:

-
-  <!-- Comment -->
-
-
+
<!-- Comment -->
+

Just plain comment, with trailing spaces on the line:

Code:

-
-  <hr />
-
-
+
<hr />
+

Hr's:

diff --git a/tests/markdown-test/links-reference.html b/tests/markdown-test/links-reference.html index 338aa22..165c71a 100644 --- a/tests/markdown-test/links-reference.html +++ b/tests/markdown-test/links-reference.html @@ -6,7 +6,5 @@

Indented twice.

Indented thrice.

Indented [four][] times.

-
-[four]: /url
-
-
\ No newline at end of file +
[four]: /url
+
\ No newline at end of file diff --git a/tests/markdown-test/markdown-documentation-basics.html b/tests/markdown-test/markdown-documentation-basics.html index bc654d2..e0edcdc 100644 --- a/tests/markdown-test/markdown-documentation-basics.html +++ b/tests/markdown-test/markdown-documentation-basics.html @@ -33,8 +33,7 @@ beginning of the line -- the number of hashes equals the resulting HTML header level.

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

Markdown:

-
-  A First Level Header
+
A First Level Header
 ====================
 
 A Second Level Header
@@ -54,11 +53,9 @@ dog's back.
 > This is the second paragraph in the blockquote.
 >
 > ## This is an H2 in a blockquote
-
-

+

Output:

-
-  <h1>A First Level Header</h1>
+
<h1>A First Level Header</h1>
 
 <h2>A Second Level Header</h2>
 
@@ -78,221 +75,170 @@ dog's back.</p>
 
     <h2>This is an H2 in a blockquote</h2>
 </blockquote>
-
-

+

Phrase Emphasis

Markdown uses asterisks and underscores to indicate spans of emphasis.

Markdown:

-
-  Some of these words *are emphasized*.
+
Some of these words *are emphasized*.
 Some of these words _are emphasized also_.
 
 Use two asterisks for **strong emphasis**.
 Or, if you prefer, __use two underscores instead__.
-
-

+

Output:

-
-  <p>Some of these words <em>are emphasized</em>.
+
<p>Some of these words <em>are emphasized</em>.
 Some of these words <em>are emphasized also</em>.</p>
 
 <p>Use two asterisks for <strong>strong emphasis</strong>.
 Or, if you prefer, <strong>use two underscores instead</strong>.</p>
-
-

+

Lists

Unordered (bulleted) lists use asterisks, pluses, and hyphens (*, +, and -) as list markers. These three markers are interchangable; this:

-
-  *   Candy.
+
*   Candy.
 *   Gum.
 *   Booze.
-
-

+

this:

-
-  +   Candy.
+
+   Candy.
 +   Gum.
 +   Booze.
-
-

+

and this:

-
-  -   Candy.
+
-   Candy.
 -   Gum.
 -   Booze.
-
-

+

all produce the same output:

-
-  <ul>
+
<ul>
 <li>Candy.</li>
 <li>Gum.</li>
 <li>Booze.</li>
 </ul>
-
-

+

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

-
-  1.  Red
+
1.  Red
 2.  Green
 3.  Blue
-
-

+

Output:

-
-  <ol>
+
<ol>
 <li>Red</li>
 <li>Green</li>
 <li>Blue</li>
 </ol>
-
-

+

If you put blank lines between items, you'll get <p> tags for the list item text. You can create multi-paragraph list items by indenting the paragraphs by 4 spaces or 1 tab:

-
-  *   A list item.
+
*   A list item.
 
     With multiple paragraphs.
 
 *   Another item in the list.
-
-

+

Output:

-
-  <ul>
+
<ul>
 <li><p>A list item.</p>
 <p>With multiple paragraphs.</p></li>
 <li><p>Another item in the list.</p></li>
 </ul>
-
-

+

Links

Markdown supports two styles for creating links: inline and reference. With both styles, you use square brackets to delimit the text you want to turn into a link.

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

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

Output:

-
-  <p>This is an <a href="http://example.com/">
+
<p>This is an <a href="http://example.com/">
 example link</a>.</p>
-
-

+

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

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

Output:

-
-  <p>This is an <a href="http://example.com/" title="With a Title">
+
<p>This is an <a href="http://example.com/" title="With a Title">
 example link</a>.</p>
-
-

+

Reference-style links allow you to refer to your links by names, which you define elsewhere in your document:

-
-  I get 10 times more traffic from [Google][1] than from
+
I get 10 times more traffic from [Google][1] than from
 [Yahoo][2] or [MSN][3].
 
 [1]: http://google.com/        "Google"
 [2]: http://search.yahoo.com/  "Yahoo Search"
 [3]: http://search.msn.com/    "MSN Search"
-
-

+

Output:

-
-  <p>I get 10 times more traffic from <a href="http://google.com/"
+
<p>I get 10 times more traffic from <a href="http://google.com/"
 title="Google">Google</a> than from <a href="http://search.yahoo.com/"
 title="Yahoo Search">Yahoo</a> or <a href="http://search.msn.com/"
 title="MSN Search">MSN</a>.</p>
-
-

+

The title attribute is optional. Link names may contain letters, numbers and spaces, but are not case sensitive:

-
-  I start my morning with a cup of coffee and
+
I start my morning with a cup of coffee and
 [The New York Times][NY Times].
 
 [ny times]: http://www.nytimes.com/
-
-

+

Output:

-
-  <p>I start my morning with a cup of coffee and
+
<p>I start my morning with a cup of coffee and
 <a href="http://www.nytimes.com/">The New York Times</a>.</p>
-
-

+

Images

Image syntax is very much like link syntax.

Inline (titles are optional):

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

Reference-style:

-
-  ![alt text][id]
+
![alt text][id]
 
 [id]: /path/to/img.jpg "Title"
-
-

+

Both of the above examples produce the same output:

-
-  <img src="/path/to/img.jpg" alt="alt text" title="Title" />
-
-
+
<img src="/path/to/img.jpg" alt="alt text" title="Title" />
+

Code

In a regular paragraph, you can create code span by wrapping text in backtick quotes. Any ampersands (&) and angle brackets (< or >) will automatically be translated into HTML entities. This makes it easy to use Markdown to write about HTML example code:

-
-  I strongly recommend against using any `<blink>` tags.
+
I strongly recommend against using any `<blink>` tags.
 
 I wish SmartyPants used named entities like `&mdash;`
 instead of decimal-encoded entites like `&#8212;`.
-
-

+

Output:

-
-  <p>I strongly recommend against using any
+
<p>I strongly recommend against using any
 <code>&lt;blink&gt;</code> tags.</p>
 
 <p>I wish SmartyPants used named entities like
 <code>&amp;mdash;</code> instead of decimal-encoded
 entites like <code>&amp;#8212;</code>.</p>
-
-

+

To specify an entire block of pre-formatted code, indent every line of the block by 4 spaces or 1 tab. Just like with code spans, &, <, and > characters will be escaped automatically.

Markdown:

-
-  If you want your page to validate under XHTML 1.0 Strict,
+
If you want your page to validate under XHTML 1.0 Strict,
 you've got to put paragraph tags in your blockquotes:
 
     <blockquote>
         <p>For example.</p>
     </blockquote>
-
-

+

Output:

-
-  <p>If you want your page to validate under XHTML 1.0 Strict,
+
<p>If you want your page to validate under XHTML 1.0 Strict,
 you've got to put paragraph tags in your blockquotes:</p>
 
 <pre><code>&lt;blockquote&gt;
     &lt;p&gt;For example.&lt;/p&gt;
 &lt;/blockquote&gt;
 </code></pre>
-
-

\ No newline at end of file
+
\ No newline at end of file diff --git a/tests/markdown-test/markdown-syntax.html b/tests/markdown-test/markdown-syntax.html index a0c12c1..c53c045 100644 --- a/tests/markdown-test/markdown-syntax.html +++ b/tests/markdown-test/markdown-syntax.html @@ -118,8 +118,7 @@ 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) <p> tags around HTML block-level tags.

For example, to add an HTML table to a Markdown article:

-
-  This is a regular paragraph.
+
This is a regular paragraph.
 
 <table>
     <tr>
@@ -128,8 +127,7 @@ to add extra (unwanted) <p> tags around HTML block-level tags
 </table>
 
 This is another regular paragraph.
-
-

+

Note that Markdown formatting syntax is not processed within block-level HTML tags. E.g., you can't use Markdown-style *emphasis* inside an HTML block.

@@ -150,15 +148,11 @@ characters, you must escape them as entities, e.g. &lt;, and

Ampersands in particular are bedeviling for web writers. If you want to write about 'AT&T', you need to write 'AT&amp;T'. You even need to escape ampersands within URLs. Thus, if you want to link to:

-
-  http://images.google.com/images?num=30&q=larry+bird
-
-
+
http://images.google.com/images?num=30&q=larry+bird
+

you need to encode the URL as:

-
-  http://images.google.com/images?num=30&amp;q=larry+bird
-
-
+
http://images.google.com/images?num=30&amp;q=larry+bird
+

in your anchor tag href 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.

@@ -167,32 +161,22 @@ all the necessary escaping for you. If you use an ampersand as part of an HTML entity, it remains unchanged; otherwise it will be translated into &amp;.

So, if you want to include a copyright symbol in your article, you can write:

-
-  &copy;
-
-
+
&copy;
+

and Markdown will leave it alone. But if you write:

-
-  AT&T
-
-
+
AT&T
+

Markdown will translate it to:

-
-  AT&amp;T
-
-
+
AT&amp;T
+

Similarly, because Markdown supports inline HTML, if you use angle brackets as delimiters for HTML tags, Markdown will treat them as such. But if you write:

-
-  4 < 5
-
-
+
4 < 5
+

Markdown will translate it to:

-
-  4 &lt; 5
-
-
+
4 &lt; 5
+

However, inside Markdown code spans and blocks, angle brackets and ampersands are always encoded automatically. This makes it easy to use Markdown to write about HTML code. (As opposed to raw HTML, which is a @@ -223,78 +207,65 @@ work best -- and look better -- when you format them with hard breaks.

Markdown supports two styles of headers, Setext and atx.

Setext-style headers are "underlined" using equal signs (for first-level headers) and dashes (for second-level headers). For example:

-
-  This is an H1
+
This is an H1
 =============
 
 This is an H2
 -------------
-
-

+

Any number of underlining ='s or -'s will work.

Atx-style headers use 1-6 hash characters at the start of the line, corresponding to header levels 1-6. For example:

-
-  # This is an H1
+
# This is an H1
 
 ## This is an H2
 
 ###### This is an H6
-
-

+

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 determines the header level.) :

-
-  # This is an H1 #
+
# This is an H1 #
 
 ## This is an H2 ##
 
 ### This is an H3 ######
-
-

+

Blockquotes

Markdown uses email-style > 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 > before every line:

-
-  > This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
+
> 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.
 > 
 > Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
 > id sem consectetuer libero luctus adipiscing.
-
-

+

Markdown allows you to be lazy and only put the > before the first line of a hard-wrapped paragraph:

-
-  > This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
+
> 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.
 
 > Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
 id sem consectetuer libero luctus adipiscing.
-
-

+

Blockquotes can be nested (i.e. a blockquote-in-a-blockquote) by adding additional levels of >:

-
-  > This is the first level of quoting.
+
> This is the first level of quoting.
 >
 > > This is nested blockquote.
 >
 > Back to the first level.
-
-

+

Blockquotes can contain other Markdown elements, including headers, lists, and code blocks:

-
-  > ## This is a header.
+
> ## This is a header.
 > 
 > 1.   This is the first list item.
 > 2.   This is the second list item.
@@ -302,8 +273,7 @@ and code blocks:

 > Here's some example code:
 > 
 >     return shell_exec("echo $input | $markdown_script");
-
-

+

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.

@@ -312,58 +282,44 @@ Quote Level from the Text menu.

Markdown supports ordered (numbered) and unordered (bulleted) lists.

Unordered lists use asterisks, pluses, and hyphens -- interchangably -- as list markers:

-
-  *   Red
+
*   Red
 *   Green
 *   Blue
-
-

+

is equivalent to:

-
-  +   Red
+
+   Red
 +   Green
 +   Blue
-
-

+

and:

-
-  -   Red
+
-   Red
 -   Green
 -   Blue
-
-

+

Ordered lists use numbers followed by periods:

-
-  1.  Bird
+
1.  Bird
 2.  McHale
 3.  Parish
-
-

+

It's important to note that the actual numbers you use to mark the list have no effect on the HTML output Markdown produces. The HTML Markdown produces from the above list is:

-
-  <ol>
+
<ol>
 <li>Bird</li>
 <li>McHale</li>
 <li>Parish</li>
 </ol>
-
-

+

If you instead wrote the list in Markdown like this:

-
-  1.  Bird
+
1.  Bird
 1.  McHale
 1.  Parish
-
-

+

or even:

-
-  3. Bird
+
3. Bird
 1. McHale
 8. Parish
-
-

+

you'd get the exact same HTML output. The point is, if you want to, you can use ordinal numbers in your ordered Markdown lists, so that the numbers in your source match the numbers in your published HTML. @@ -375,58 +331,45 @@ starting ordered lists at an arbitrary number.

up to three spaces. List markers must be followed by one or more spaces or a tab.

To make lists look nice, you can wrap items with hanging indents:

-
-  *   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
+
*   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.
     Suspendisse id sem consectetuer libero luctus adipiscing.
-
-

+

But if you want to be lazy, you don't have to:

-
-  *   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
+
*   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.
 Suspendisse id sem consectetuer libero luctus adipiscing.
-
-

+

If list items are separated by blank lines, Markdown will wrap the items in <p> tags in the HTML output. For example, this input:

-
-  *   Bird
+
*   Bird
 *   Magic
-
-

+

will turn into:

-
-  <ul>
+
<ul>
 <li>Bird</li>
 <li>Magic</li>
 </ul>
-
-

+

But this:

-
-  *   Bird
+
*   Bird
 
 *   Magic
-
-

+

will turn into:

-
-  <ul>
+
<ul>
 <li><p>Bird</p></li>
 <li><p>Magic</p></li>
 </ul>
-
-

+

List items may consist of multiple paragraphs. Each subsequent paragraph in a list item must be intended by either 4 spaces or one tab:

-
-  1.  This is a list item with two paragraphs. Lorem ipsum dolor
+
1.  This is a list item with two paragraphs. Lorem ipsum dolor
     sit amet, consectetuer adipiscing elit. Aliquam hendrerit
     mi posuere lectus.
 
@@ -435,50 +378,39 @@ or one tab:

     sit amet velit.
 
 2.  Suspendisse id sem consectetuer libero luctus adipiscing.
-
-

+

It looks nice if you indent every line of the subsequent paragraphs, but here again, Markdown will allow you to be lazy:

-
-  *   This is a list item with two paragraphs.
+
*   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
 sit amet, consectetuer adipiscing elit.
 
 *   Another item in the same list.
-
-

+

To put a blockquote within a list item, the blockquote's > delimiters need to be indented:

-
-  *   A list item with a blockquote:
+
*   A list item with a blockquote:
 
     > This is a blockquote
     > inside a list item.
-
-

+

To put a code block within a list item, the code block needs to be indented twice -- 8 spaces or two tabs:

-
-  *   A list item with a code block:
+
*   A list item with a code block:
 
         <code goes here>
-
-

+

It's worth noting that it's possible to trigger an ordered list by accident, by writing something like this:

-
-  1986. What a great season.
-
-
+
1986. What a great season.
+

In other words, a number-period-space sequence at the beginning of a line. To avoid this, you can backslash-escape the period:

-
-  1986\. What a great season.
-
-
+
1986\. What a great season.
+

Code Blocks

Pre-formatted code blocks are used for writing about programming or @@ -487,40 +419,32 @@ of a code block are interpreted literally. Markdown wraps a code block in both <pre> and <code> tags.

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:

-
-  This is a normal paragraph:
+
This is a normal paragraph:
 
     This is a code block.
-
-

+

Markdown will generate:

-
-  <p>This is a normal paragraph:</p>
+
<p>This is a normal paragraph:</p>
 
 <pre><code>This is a code block.
 </code></pre>
-
-

+

One level of indentation -- 4 spaces or 1 tab -- is removed from each line of the code block. For example, this:

-
-  Here is an example of AppleScript:
+
Here is an example of AppleScript:
 
     tell application "Foo"
         beep
     end tell
-
-

+

will turn into:

-
-  <p>Here is an example of AppleScript:</p>
+
<p>Here is an example of AppleScript:</p>
 
 <pre><code>tell application "Foo"
     beep
 end tell
 </code></pre>
-
-

+

A code block continues until it reaches a line that is not indented (or the end of the article).

Within a code block, ampersands (&) and angle brackets (< and >) @@ -528,20 +452,16 @@ are automatically converted into HTML entities. This makes it very 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:

-
-      <div class="footer">
+
    <div class="footer">
         &copy; 2004 Foo Corporation
     </div>
-
-

+

will turn into:

-
-  <pre><code>&lt;div class="footer"&gt;
+
<pre><code>&lt;div class="footer"&gt;
     &amp;copy; 2004 Foo Corporation
 &lt;/div&gt;
 </code></pre>
-
-

+

Regular Markdown syntax is not processed within code blocks. E.g., asterisks are just literal asterisks within a code block. This means it's also easy to use Markdown to write about Markdown's own syntax.

@@ -551,8 +471,7 @@ it's also easy to use Markdown to write about Markdown's own syntax.

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:

-
-  * * *
+
* * *
 
 ***
 
@@ -563,8 +482,7 @@ following lines will produce a horizontal rule:

 ---------------------------------------
 
 _ _ _
-
-

+

Span Elements

@@ -576,44 +494,32 @@ _ _ _ after the link text's closing square bracket. Inside the parentheses, put the URL where you want the link to point, along with an optional title for the link, surrounded in quotes. For example:

-
-  This is [an example](http://example.com/ "Title") inline link.
+
This is [an example](http://example.com/ "Title") inline link.
 
 [This link](http://example.net/) has no title attribute.
-
-

+

Will produce:

-
-  <p>This is <a href="http://example.com/" title="Title">
+
<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
 title attribute.</p>
-
-

+

If you're referring to a local resource on the same server, you can use relative paths:

-
-  See my [About](/about/) page for details.
-
-
+
See my [About](/about/) page for details.
+

Reference-style links use a second set of square brackets, inside which you place a label of your choosing to identify the link:

-
-  This is [an example][id] reference-style link.
-
-
+
This is [an example][id] reference-style link.
+

You can optionally use a space to separate the sets of brackets:

-
-  This is [an example] [id] reference-style link.
-
-
+
This is [an example] [id] reference-style link.
+

Then, anywhere in the document, you define your link label like this, on a line by itself:

-
-  [id]: http://example.com/  "Optional Title Here"
-
-
+
[id]: http://example.com/  "Optional Title Here"
+

That is:

  • Square brackets containing the link identifier (optionally @@ -625,90 +531,68 @@ indented from the left margin using up to three spaces);
    • in double or single quotes.

The link URL may, optionally, be surrounded by angle brackets:

-
-  [id]: <http://example.com/>  "Optional Title Here"
-
-
+
[id]: <http://example.com/>  "Optional Title Here"
+

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:

-
-  [id]: http://example.com/longish/path/to/resource/here
+
[id]: http://example.com/longish/path/to/resource/here
     "Optional Title Here"
-
-

+

Link definitions are only used for creating links during Markdown processing, and are stripped from your document in the HTML output.

Link definition names may constist of letters, numbers, spaces, and punctuation -- but they are not case sensitive. E.g. these two links:

-
-  [link text][a]
+
[link text][a]
 [link text][A]
-
-

+

are equivalent.

The implicit link name 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][]
-
-
+
[Google][]
+

And then define the link:

-
-  [Google]: http://google.com/
-
-
+
[Google]: http://google.com/
+

Because link names may contain spaces, this shortcut even works for multiple words in the link text:

-
-  Visit [Daring Fireball][] for more information.
-
-
+
Visit [Daring Fireball][] for more information.
+

And then define the link:

-
-  [Daring Fireball]: http://daringfireball.net/
-
-
+
[Daring Fireball]: http://daringfireball.net/
+

Link definitions can be placed anywhere in your Markdown document. I tend to put them immediately after each paragraph in which they're used, but if you want, you can put them all at the end of your document, sort of like footnotes.

Here's an example of reference links in action:

-
-  I get 10 times more traffic from [Google] [1] than from
+
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"
-
-

+

Using the implicit link name shortcut, you could instead write:

-
-  I get 10 times more traffic from [Google][] than from
+
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"
-
-

+

Both of the above examples will produce the following HTML output:

-
-  <p>I get 10 times more traffic from <a href="http://google.com/"
+
<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>
-
-

+

For comparison, here is the same paragraph written using Markdown's inline link style:

-
-  I get 10 times more traffic from [Google](http://google.com/ "Google")
+
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").
-
-

+

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 @@ -727,107 +611,79 @@ prose.

emphasis. Text wrapped with one * or _ will be wrapped with an HTML <em> tag; double *'s or _'s will be wrapped with an HTML <strong> tag. E.g., this input:

-
-  *single asterisks*
+
*single asterisks*
 
 _single underscores_
 
 **double asterisks**
 
 __double underscores__
-
-

+

will produce:

-
-  <em>single asterisks</em>
+
<em>single asterisks</em>
 
 <em>single underscores</em>
 
 <strong>double asterisks</strong>
 
 <strong>double underscores</strong>
-
-

+

You can use whichever style you prefer; the lone restriction is that the same character must be used to open and close an emphasis span.

Emphasis can be used in the middle of a word:

-
-  un*fucking*believable
-
-
+
un*fucking*believable
+

But if you surround an * or _ with spaces, it'll be treated as a literal asterisk or underscore.

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:

-
-  \*this text is surrounded by literal asterisks\*
-
-
+
\*this text is surrounded by literal asterisks\*
+

Code

To indicate a span of code, wrap it with backtick quotes (`). Unlike a pre-formatted code block, a code span indicates code within a normal paragraph. For example:

-
-  Use the `printf()` function.
-
-
+
Use the `printf()` function.
+

will produce:

-
-  <p>Use the <code>printf()</code> function.</p>
-
-
+
<p>Use the <code>printf()</code> function.</p>
+

To include a literal backtick character within a code span, you can use multiple backticks as the opening and closing delimiters:

-
-  ``There is a literal backtick (`) here.``
-
-
+
``There is a literal backtick (`) here.``
+

which will produce this:

-
-  <p><code>There is a literal backtick (`) here.</code></p>
-
-
+
<p><code>There is a literal backtick (`) here.</code></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:

-
-  A single backtick in a code span: `` ` ``
+
A single backtick in a code span: `` ` ``
 
 A backtick-delimited string in a code span: `` `foo` ``
-
-

+

will produce:

-
-  <p>A single backtick in a code span: <code>`</code></p>
+
<p>A single backtick in a code span: <code>`</code></p>
 
 <p>A backtick-delimited string in a code span: <code>`foo`</code></p>
-
-

+

With a code span, ampersands and angle brackets are encoded as HTML entities automatically, which makes it easy to include example HTML tags. Markdown will turn this:

-
-  Please don't use any `<blink>` tags.
-
-
+
Please don't use any `<blink>` tags.
+

into:

-
-  <p>Please don't use any <code>&lt;blink&gt;</code> tags.</p>
-
-
+
<p>Please don't use any <code>&lt;blink&gt;</code> tags.</p>
+

You can write this:

-
-  `&#8212;` is the decimal-encoded equivalent of `&mdash;`.
-
-
+
`&#8212;` is the decimal-encoded equivalent of `&mdash;`.
+

to produce:

-
-  <p><code>&amp;#8212;</code> is the decimal-encoded
+
<p><code>&amp;#8212;</code> is the decimal-encoded
 equivalent of <code>&amp;mdash;</code>.</p>
-
-

+

Images

Admittedly, it's fairly difficult to devise a "natural" syntax for @@ -835,12 +691,10 @@ placing images into a plain text document format.

Markdown uses an image syntax that is intended to resemble the syntax for links, allowing for two styles: inline and reference.

Inline image syntax looks like this:

-
-  ![Alt text](/path/to/img.jpg)
+
![Alt text](/path/to/img.jpg)
 
 ![Alt text](/path/to/img.jpg "Optional title")
-
-

+

That is:

  • An exclamation mark: !;
    • @@ -851,16 +705,12 @@ the image, and an optional title attribute enclosed in double or single quotes.

Reference-style image syntax looks like this:

-
-  ![Alt text][id]
-
-
+
![Alt text][id]
+

Where "id" is the name of a defined image reference. Image references are defined using syntax identical to link references:

-
-  [id]: url/to/image  "Optional title attribute"
-
-
+
[id]: url/to/image  "Optional title attribute"
+

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 <img> tags.

@@ -870,31 +720,23 @@ use regular HTML <img> tags.

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:

-
-  <http://example.com/>
-
-
+
<http://example.com/>
+

Markdown will turn this into:

-
-  <a href="http://example.com/">http://example.com/</a>
-
-
+
<a href="http://example.com/">http://example.com/</a>
+

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 spambots. For example, Markdown will turn this:

-
-  <address@example.com>
-
-
+
<address@example.com>
+

into something like this:

-
-  <a href="&#x6D;&#x61;i&#x6C;&#x74;&#x6F;:&#x61;&#x64;&#x64;&#x72;&#x65;
+
<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>
-
-

+

which will render in a browser as a clickable link to "address@example.com".

(This sort of entity-encoding trick will indeed fool many, if not most, address-harvesting bots, but it definitely won't fool all of @@ -907,13 +749,10 @@ 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 <em> tag), you can backslashes before the asterisks, like this:

-
-  \*literal asterisks\*
-
-
+
\*literal asterisks\*
+

Markdown provides backslash escapes for the following characters:

-
-  \   backslash
+
\   backslash
 `   backtick
 *   asterisk
 _   underscore
@@ -925,5 +764,4 @@ _   underscore
 -   minus sign (hyphen)
 .   dot
 !   exclamation mark
-
-

\ No newline at end of file
+
\ No newline at end of file diff --git a/tests/markdown-test/tabs.html b/tests/markdown-test/tabs.html index f90fb95..f302d5f 100644 --- a/tests/markdown-test/tabs.html +++ b/tests/markdown-test/tabs.html @@ -1,29 +1,23 @@
    -
  • -

    this is a list item +

  • +

    this is a list item indented with tabs

    -
    • -
  • -

    this is a list item +

    • +
  • +

    this is a list item indented with spaces

    -
    • +

Code:

-
-this code block is indented by one tab
-
-
+
this code block is indented by one tab
+

And:

-
-    this code block is indented by two tabs
-
-
+
    this code block is indented by two tabs
+

And:

-
-+   this is an example list item
+
+   this is an example list item
     indented with tabs
 
 +   this is an example list item
     indented with spaces
-
-

+
\ No newline at end of file diff --git a/tests/misc/arabic.html b/tests/misc/arabic.html index 830d62a..073febb 100644 --- a/tests/misc/arabic.html +++ b/tests/misc/arabic.html @@ -5,13 +5,10 @@

تتميز بايثون بمجتمعها النشط ، كما أن لها الكثير من المكتبات البرمجية ذات الأغراض الخاصة والتي برمجها أشخاص من مجتمع هذه اللغة ، مثلاً مكتبة PyGame التي توفر مجموعه من الوظائف من اجل برمجة الالعاب. ويمكن لبايثون التعامل مع العديد من أنواع قواعد البيانات مثل MySQL وغيره.

أمثلة

مثال Hello World!

-
-  print "Hello World!"
-
-
+
print "Hello World!"
+

مثال لاستخراج المضروب Factorial :

-
-  num = 1
+
num = 1
 x = raw_input('Insert the number please ')
 x = int(x)
 
@@ -23,13 +20,11 @@ else:
   x = x-1
 
  print num
-
-

+

وصلات خارجية

-

بذرة حاس

- +

بذرة حاس

\ No newline at end of file diff --git a/tests/misc/bidi.html b/tests/misc/bidi.html index e7759f1..8f94062 100644 --- a/tests/misc/bidi.html +++ b/tests/misc/bidi.html @@ -17,13 +17,10 @@

تتميز بايثون بمجتمعها النشط ، كما أن لها الكثير من المكتبات البرمجية ذات الأغراض الخاصة والتي برمجها أشخاص من مجتمع هذه اللغة ، مثلاً مكتبة PyGame التي توفر مجموعه من الوظائف من اجل برمجة الالعاب. ويمكن لبايثون التعامل مع العديد من أنواع قواعد البيانات مثل MySQL وغيره.

أمثلة

مثال Hello World!

-
-  print "Hello World!"
-
-
+
print "Hello World!"
+

مثال لاستخراج المضروب Factorial :

-
-  num = 1
+
num = 1
 x = raw_input('Insert the number please ')
 x = int(x)
 
@@ -35,8 +32,7 @@ else:
   x = x-1
 
  print num
-
-

+

وصلات خارجية

  • @@ -47,5 +43,4 @@ else:

    Недвард «Нед» Фландерс (Nedward «Ned» Flanders) — вымышленный персонаж мультсериала «[Симпсоны][]», озвученный Гарри Ширером. Он и его семья живут по соседству от семьи Симпсонов. Набожный христианин, Нед является одним из столпов морали Спрингфилда. В эпизоде «Alone Again, Natura-Diddily» он овдовел, его жена Мод погибла в результате несчастного случая.

    Нед был одним из первых персонажей в мультсериале, который не был членом семьи Симпсонов. Начиная с первых серий, он регулярно появляется в «Симпсонах». Считается, что Нед Фландерс был назван в честь улицы Northeast Flanders St. в Портленде, Орегон, родном городе создателя мультсериала Мэтта Грейнинга]]. Надпись на указателе улицы NE Flanders St. хулиганы часто исправляли на NED Flanders St. -

    - +

    \ No newline at end of file diff --git a/tests/misc/blockquote.html b/tests/misc/blockquote.html index 429c6d0..7268578 100644 --- a/tests/misc/blockquote.html +++ b/tests/misc/blockquote.html @@ -12,14 +12,11 @@

    baz

    > this has three spaces so its a paragraph.

    blah

    -
    -  > this one had four so it's a code block.
-
-
    +
    > this one had four so it's a code block.
+

    this nested blockquote has 0 on level one and 3 (one after the first > + 2 more) on level 2.

    > and this has 4 on level 2 - another code block.

    -
    - + \ No newline at end of file diff --git a/tests/misc/br.html b/tests/misc/br.html index 52b4796..08563a5 100644 --- a/tests/misc/br.html +++ b/tests/misc/br.html @@ -1,12 +1,10 @@

    Output:

    -
    -<p>Some of these words <em>are emphasized</em>.
+
    <p>Some of these words <em>are emphasized</em>.
 Some of these words <em>are emphasized also</em>.</p>
 
 <p>Use two asterisks for <strong>strong emphasis</strong>.
 Or, if you prefer, <strong>use two underscores instead</strong>.</p>
-
-
    
+

    Lists

    Unordered (bulleted) lists use asterisks, pluses, and hyphens (*, +, and -) as list markers. These three markers are diff --git a/tests/misc/code-first-line.html b/tests/misc/code-first-line.html index 177463f..1fb0b7c 100644 --- a/tests/misc/code-first-line.html +++ b/tests/misc/code-first-line.html @@ -1,4 +1,2 @@ -

    -print "This is a code block."
-
-
    \ No newline at end of file +
    print "This is a code block."
+
    \ No newline at end of file diff --git a/tests/misc/multi-test.html b/tests/misc/multi-test.html index 1fc7bdb..552852d 100644 --- a/tests/misc/multi-test.html +++ b/tests/misc/multi-test.html @@ -16,9 +16,6 @@ Let's continue.

    [^1]: Here is the text of the footnote continued on several lines. some more of the footnote, etc.

    -
    -  Actually, another paragraph too.
-
-
    -

    And then there is a little bit of text.

    - +
    Actually, another paragraph too.
+
    +

    And then there is a little bit of text.

    \ No newline at end of file diff --git a/tests/misc/some-test.html b/tests/misc/some-test.html index 54a3e23..e43cb94 100644 --- a/tests/misc/some-test.html +++ b/tests/misc/some-test.html @@ -1,72 +1,70 @@
      -
    • -

      as if

      -
      • -
    • -

      as if2

      -
      • +
    • +

      as if

      +
      • +
    • +

      as if2

      +
      -
    • -

      as if

      -
      • -
    • -

      as if2

      -
      • +
    • +

      as if

      +
      • +
    • +

      as if2

      +
      -
    • as if +
    • as if non_code
      • -
    • as if2
      • +
    • as if2

    Markdown

      -
    • -

      Python +

    • +

      Python is ok

      -
        -
      • Therefore i am
        • -
      -
      • -
    • -

      Perl sucks +

        +
      • Therefore i am
        • +
      +
      • +
    • +

      Perl sucks big time

      -
        -
      • But that's +
          +
        • But that's ok
          • -
        -
        • -
      • -

        Python is +

      +
      • +
    • +

      Python is ok Or not?

      -
      • +

    Here is a normal paragraph

      -
    1. -

      Another list +

    2. +

      Another list with a bunch of items

      -
      3. -
    3. -

      Mostly fruits

      -
        -
      1. Apple
        2. -
      2. Pare
        3. -
      -
      4. + +
    4. +

      Mostly fruits

      +
        +
      1. Apple
        2. +
      2. Pare
        3. +
      +

    asdfasdfasd

    -
    -# This is a code example
+
    # This is a code example
 import stuff
 
 Another code example
 * Lists and similar stuff
 
 > Should be ignored
-
-
    
+
    \ No newline at end of file diff --git a/tests/safe_mode/inline-html-simple.html b/tests/safe_mode/inline-html-simple.html index ceaaa90..ad19a77 100644 --- a/tests/safe_mode/inline-html-simple.html +++ b/tests/safe_mode/inline-html-simple.html @@ -3,17 +3,13 @@ foo </div>

    This should be a code block, though:

    -
    -<div>
+
    <div>
     foo
 </div>
-
-
    
+

    As should this:

    -
    -<div>foo</div>
-
-
    +
    <div>foo</div>
+

    Now, nested:

    <div> <div> @@ -30,17 +26,13 @@ Blah Blah -->

    Code block:

    -
    -<!-- Comment -->
-
-
    +
    <!-- Comment -->
+

    Just plain comment, with trailing spaces on the line:

    <!-- foo -->

    Code:

    -
    -<hr />
-
-
    +
    <hr />
+

    Hr's:

    <hr>

    <hr/>

    -- cgit v1.2.3