Tcl Library Source Code

[comment {-*- tcl -*- doctools manpage}]
[manpage_begin markdown n 1.0]
[moddesc   {Markdown to HTML Converter}]
[titledesc {Converts Markdown text to HTML}]
[category  {Text processing}]
[require Tcl 8.5]
[require textutil [opt 0.8]]
[description]

The package [package Markdown] provides a command to convert
Markdown annotated text into HMTL. 

[list_begin definitions]
[call [cmd ::Markdown::convert] [arg "markdown"]]

This command takes in a block of Markdown text, and returns a block
of HTML.
[list_end]

[vset CATEGORY textutil]
[include ../doctools2base/include/feedback.inc]
[manpage_end]

# Markdown

*Markdown* is a Markdown to XHTML processor.  It supports the original 
basic syntax as defined by John Gruber on his homepage at [http://daringfireball.net/projects/markdown/syntax](http://daringfireball.net/projects/markdown/syntax).

# Markdown Dialect

Tcl-markdown is intended to support the same range of inputs and outputs
as John Gruber's original Markdown processor.

Common extensions are not supported at this time.

## Known Bugs

Per Markdown.mdtest, reflink text can contain brackets.   This input
should produce a link to the "/url/"; at present it does not
(see Tcl-markdown test mdtest-1.3):
```
With [embedded [brackets]] [b].

[b]: /url/
```

Simple reference links are ignored.  The following link should be
expanded, but it isn't (see Tcl-markdown test mdtest-1.4):

```
Simple link [this].

[this]: /url/
```

Oddly, a line beginning and ending with brackets can contain 
reference links within it.  The following links should be expanded,
but are not (see Tcl-markdown tests mdtest-1.5 and 1.6):

```
[Links can be [embedded][] in brackets]
[Links can be [embedded] in brackets]

[embedded]: /url/

```

Simple reflinks can have line breaks in them; these are currently not
supported (see Tcl-markdown tests mdtest-1.7 and 1.8):

```
The [link
breaks] across lines.

The [link 
breaks] across lines, but with a line-ending space.

[link breaks]: /url/

```

## Mdtest Results

Tcl-markdown has been run against the Markdown.mdtest test set provided by 
[mdtest](https://github.com/michelf/mdtest) test suite, with mixed 
results.  

* Running the test suite on OSX 10.8.5, using PHP 5.3.28, most
  tests fail.  Examination of the results reveals that most of the 
  "failures" involve whitespace differences with no effect on the rendered
  appearance of the output.

* Running the test suite on OSX 10.9, using PHP 5.4.30, most tests pass.
  The test files and Tcl-markdown outputs are identical on both platforms.
  My conjecture is that an XML-parser is used to compare the actual and
  expected results, and that the comparison is a little more forgiving on 
  PHP 5.4.30.

I am trying to fix substantive bugs; but see the mdtest-\*.\* tests
in test/markdown/markdown.test that are tagged with the constraint
"knownbug".

## CommonMark Results

Tcl-markdown has not been run against the CommonMark test suite as yet.
I would like to evolve it into a CommonMark compliant processor, but that
will take some time.

# Provenance

This module originated as the Tcl-Markdown project by Tobias Koch and Danyil Bohdan, 
as part of the Caius Test Tool. [https://github.com/tobijk/caius/](https://github.com/tobijk/caius/)

That module incorporated into Tcllib is based on a version that modifed and enhanced 
by Will Duquette. [https://github.com/wduquette/tcl-markdown](https://github.com/wduquette/tcl-markdown)

# tool.test - Copyright (c) 2016 Sean Woods, Will DuQuette, Caius Project
# -------------------------------------------------------------------------
#-------------------------------------------------------------------------
# TITLE:
#    markdown.test
#
# PROJECT:
#    tcl-markdown: Your project description
#
# DESCRIPTION:
#    markdown: Test Suite
#-------------------------------------------------------------------------

source [file join \
	[file dirname [file dirname [file join [pwd] [info script]]]] \
	devtools testutilities.tcl]

testsNeedTcl     8.5
testsNeedTcltest 2

support {

    use textutil/textutil.tcl textutil
}
testing {
    useLocal markdown.tcl Markdown
}

#-------------------------------------------------------------------------
# Setup

tcltest::testConstraint knownbug 0


# outdent text
#
# text   - A multi-line text string
#
# This command outdents a multi-line text string to the left margin.

proc outdent {text} {
    # FIRST, remove any leading blank lines
    regsub {\A(\s*\n)} $text "" text

    # NEXT, remove any trailing whitespace
    set text [string trimright $text]

    # NEXT, get the length of the leading on the first line.
    if {[regexp {\A(\s*)\S} $text dummy leader]} {

        # Remove the leader from the beginning of each indented
        # line, and update the string.
        regsub -all -line "^$leader" $text "" text
    }

    return $text
}


proc cmp {s1 s2} {
    set s1 [string trim $s1]
    set s2 [string trim $s2]

    return [expr {$s1 eq $s2}]
}

proc dumpcmp {s1 s2} {
    set s1 [string trim $s1]
    set s2 [string trim $s2]

    puts "# START S1"
    puts $s1
    puts "# START S2"
    puts $s2
    puts "# END TEXT"
    puts "# LENGTH = [string length $s1], [string length $s2]"
}

# convert in
#
# in - markdown input, possibly indented.
#
# Outdents the input and converts it to HTML.  Indents it for inclusion
# in a result.
proc convert {in} {
    set lines [split [string trim [Markdown::convert [outdent $in]]] \n]

    set out [join $lines "\n    "]
    return "\n    $out\n"
}

#=========================================================================
# Tcl-markdown tests

#-------------------------------------------------------------------------
# Conversion tests

test basic-1.1 {basic text} -body {
    convert {
        A line of text.

        Another line of text.
    }
} -result {
    <p>A line of text.</p>
    
    <p>Another line of text.</p>
}

test basic-1.2 {multi-line paragraphs} -body {
    convert {
        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
        eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut
        enim ad minim veniam, quis nostrud exercitation ullamco laboris
        nisi ut aliquip ex ea commodo consequat. 

        Duis aute irure dolor in reprehenderit in voluptate velit esse 
        cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat 
        cupidatat non proident, sunt in culpa qui officia deserunt mollit 
        anim id est laborum.
    }
} -result {
    <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
    eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut
    enim ad minim veniam, quis nostrud exercitation ullamco laboris
    nisi ut aliquip ex ea commodo consequat.</p>
    
    <p>Duis aute irure dolor in reprehenderit in voluptate velit esse 
    cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat 
    cupidatat non proident, sunt in culpa qui officia deserunt mollit 
    anim id est laborum.</p>
}

test bquote-1.1 {simple blockquote} -body {
    convert {
        >
        > A line of text.
        >
    }
} -result {
    <blockquote>
    <p>A line of text.</p>
    </blockquote>
}

test bquote-1.2 {">" on first line only.} -body {
    convert {
        > Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
        eiusmod tempor incididunt ut labore et dolore magna aliqua.
    }
} -result {
    <blockquote>
    <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
    eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
    </blockquote>
}

test bquote-1.3 {block quote with markup} -body {
    convert {
        > ### Heading 3
        > 
        > Lorem ipsum dolor sit amet, consectetur adipiscing elit
    }
} -result {
    <blockquote>
    <h3>Heading 3</h3>
    
    <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit</p>
    </blockquote>
}

test bquote-1.4 {nested block quotes} -body {
    convert {
        > First this.
        >
        > > And then this and this
        > > and this.
        > 
        > And then this.
    }
} -result {
    <blockquote>
    <p>First this.</p>
    
    <blockquote>
    <p>And then this and this
    and this.</p>
    </blockquote>
    
    <p>And then this.</p>
    </blockquote>
}

test bquote-1.5 {complex case (from Caius test suite)} -body {
    convert {
        >
        > > This is what he said. This is what she said. This is what
        > > he said. This is what she said.
        > >
        > > ### Heading 3 #####
        > >
        > > This is what he said. This is what she said. This is what
        > > he said. This is what she said.
        > >     
        > >     import os
        > >     os.path.listdir()
        > >
        > > This is what he said. This is what she said. This is what
        > > he said. This is what she said.
        >
        > ## Heading 2
        >
        > This is what he said. This is what she said. This is what
        > he said. This is what she said.

        This is a test.
    }
} -result {
    <blockquote>
    <blockquote>
    <p>This is what he said. This is what she said. This is what
    he said. This is what she said.</p>
    
    <h3>Heading 3</h3>
    
    <p>This is what he said. This is what she said. This is what
    he said. This is what she said.</p>
    
    <pre><code>import os
    os.path.listdir()</code></pre>
    
    <p>This is what he said. This is what she said. This is what
    he said. This is what she said.</p>
    </blockquote>
    
    <h2>Heading 2</h2>
    
    <p>This is what he said. This is what she said. This is what
    he said. This is what she said.</p>
    </blockquote>
    
    <p>This is a test.</p>
}



test convert-2.2 {refs} -body {
    convert {
        Find it [here][foo]!

        [foo]: http://example.com/  "Optional Title Here"
    }
} -result {
    <p>Find it <a href="http://example.com/" title="Optional Title Here">here</a>!</p>
}


#=========================================================================
# Tests related to other processors or test suites

#-------------------------------------------------------------------------
# Caius Markdown Tests
#
# These tests translate entire files.  I prefer tests for individual 
# features; when a test fails, you don't need to go hunting for the
# specifics.  But I'm keeping these to show compatibility with the 
# Caius processor.

# 1.* - Caius markdown tests

test caius-1.1 {bq test} -body {
    set md   [::tcltest::viewFile test/bq.md]
    set html [::tcltest::viewFile test/bq.html]

    cmp $html [Markdown::convert $md]
} -result {1}

test caius-1.2 {code test} -body {
    set md   [::tcltest::viewFile test/code.md]
    set html [::tcltest::viewFile test/code.html]

    cmp $html [Markdown::convert $md]
} -result {1}

test caius-1.3 {comments test} -body {
    set md   [::tcltest::viewFile test/comments.md]
    set html [::tcltest::viewFile test/comments.html]
    cmp $html [Markdown::convert $md]
} -result {1}

test caius-1.4 {inline test} -body {
    set md   [::tcltest::viewFile test/inline.md]
    set html [::tcltest::viewFile test/inline.html]
    cmp $html [Markdown::convert $md]
} -result {1}

test caius-1.5 {lists test} -body {
    set md   [::tcltest::viewFile test/lists.md]
    set html [::tcltest::viewFile test/lists.html]
    cmp $html [Markdown::convert $md]
} -result {1}

test caius-1.6 {p_br_h_hr test} -body {
    set md   [::tcltest::viewFile test/p_br_h_hr.md]
    set html [::tcltest::viewFile test/p_br_h_hr.html]
    cmp $html [Markdown::convert $md]
} -result {1}

test caius-1.7 {indent test} -body {
    set md   [::tcltest::viewFile test/indent.md]
    set html [::tcltest::viewFile test/indent.html]
    cmp $html [Markdown::convert $md]
} -result {1}

#-------------------------------------------------------------------------
# mdtest: Bugs found while running michelf/mdtest


test mdtest-1.1 {AL: Auto links: & not escaped in URL} -body {
    convert {
        Auto-link with ampersand: <http://example.com/?foo=1&bar=2>
    }
} -result {
    <p>Auto-link with ampersand: <a href="http://example.com/?foo=1&amp;bar=2">http://example.com/?foo=1&amp;bar=2</a></p>
}

test mdtest-1.2 {Undefined refs cause syntax error} -body {
    convert {
        Undefined ref: [foo]
    }
} -result {
    <p>Undefined ref: [foo]</p>
}

test mdtest-1.3 {LRS: Embedded brackets in link} -constraints knownbug -body {
    convert {
        With [embedded [brackets]] [b].

        [b]: /url/
    }
} -result {
    <p>With <a href="/url/">embedded [brackets]</a>.</p>
}

test mdtest-1.4 {LRS: Simple reflink} -constraints knownbug -body {
    convert {
        Simple link [this].

        [this]: /url/
    }
} -result {
    <p>Simple link <a href="/url/">this</a>.</p>
}


test mdtest-1.5 {LRS: Reflink embedded in brackets 1} -constraints knownbug -body {
    convert {
        [Links can be [embedded][] in brackets]

        [embedded]: /url/
    }
} -result {
    <p>[Links can be <a href="/url/">embedded</a> in brackets]</p>
}

test mdtest-1.6 {LRS: Reflink embedded in brackets 2} -constraints knownbug -body {
    convert {
        [Links can be [embedded] in brackets]

        [embedded]: /url/
    }
} -result {
    <p>[Links can be <a href="/url/">embedded</a> in brackets]</p>
}

test mdtest-1.7 {LRS: link breaks across lines, 1} -constraints knownbug -body {
    convert {
        The [link
        breaks] across lines.

        [link breaks]: /url/
    }
} -result {
    <p>The <a href="/url/">link
    breaks</a> across lines.</p>
}

test mdtest-1.8 {LRS: link breaks across lines, 2} -constraints knownbug -body {
    convert {
        The [link 
        breaks] across lines, but with a line-ending space.

        [link breaks]: /url/
    }
} -result {
    <p>The <a href="/url/">link 
    breaks</a> across lines, but with a line-ending space.</p>
}

test mdtest-1.9 {OAUL: "* * *" line after unordered list} -body {
    # This causes the processor to hang.
    convert {
        * asterisk 1

        * * *
    }
} -result {
    <ul>
    <li><p>asterisk 1</p>
    
    </li>
    <li><p>* *</p></li></ul>
}

#-------------------------------------------------------------------------
# Cleanup

testsuiteCleanup

<h1>Heading 1</h1>

<blockquote>
<h1>Heading 1</h1>

<p>This is what he said. This is what she said. This is what
he said. This is what she said.</p>

<blockquote>
<p>This is what he said. This is what she said. This is what
he said. This is what she said.</p>

<h3>Heading 3</h3>

<p>This is what he said. This is what she said. This is what
he said. This is what she said.</p>

<pre><code>import os
os.path.listdir()</code></pre>

<p>This is what he said. This is what she said. This is what
he said. This is what she said.</p>
</blockquote>

<h2>Heading 2</h2>

<p>This is what he said. This is what she said. This is what
he said. This is what she said.</p>
</blockquote>

<p>This is a test.</p>

Heading 1
=====

> 
> Heading 1
> ====


> This is what he said. This is what she said. This is what
he said. This is what she said.

>
> > This is what he said. This is what she said. This is what
> > he said. This is what she said.
> >
> > ### Heading 3 #####
> >
> > This is what he said. This is what she said. This is what
> > he said. This is what she said.
> >     
> >     import os
> >     os.path.listdir()
> >
> > This is what he said. This is what she said. This is what
> > he said. This is what she said.
>
> ## Heading 2
>
> This is what he said. This is what she said. This is what
> he said. This is what she said.

This is a test.

<h1>Test code blocks</h1>

<p>There is some code coming up. There is some code
coming up. There is some code coming up. There is
some code coming up.</p>

<pre><code>import os

fp = file(&quot;test.text&quot;, &quot;rb&quot;)
buf = fp.read()</code></pre>

<p>There is some code coming up. There is some code
coming up. There is some code coming up. There is
some code coming up.</p>

<pre><code>&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;
&lt;html&gt;
    &lt;head&gt;
        &lt;title&gt;Title&lt;/title&gt;
    &lt;/head&gt;
    &lt;body&gt;
        Body text...
    &lt;/body&gt;
&lt;/html&gt;</code></pre>

Test code blocks
===

There is some code coming up. There is some code
coming up. There is some code coming up. There is
some code coming up.

    import os

    fp = file("test.text", "rb")
    buf = fp.read()

There is some code coming up. There is some code
coming up. There is some code coming up. There is
some code coming up.

    <?xml version="1.0" encoding="utf-8"?>
    <html>
        <head>
            <title>Title</title>
        </head>
        <body>
            Body text...
        </body>
    </html>

<p>There is a paragraph. There is a paragraph. There is
a paragraph. <!-- inline comment --> There is a paragraph.
There is a paragraph. <!-- inline
comment --> There is a paragraph. There is a paragraph.
There is a paragraph.</p>

<!-- There is a single line comment -->

<p>There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph. <!-- There is a single line comment --></p>

<p>There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph.
<!-- There is a single line comment --></p>

<p><!-- There is a single line comment -->
There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph. <!-- There is a single line comment --></p>

<p>There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph.</p>

<!-- There
   is a
   multi
   line
   comment -->

<p>There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph.<!-- There
   is a
   multi
   line
   comment --></p>

<p><!-- There
   is a
   multi
   line
   comment -->
There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph.</p>

<p>There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph.</p>

<!-- There
   is a
   multi
   line
   comment -->
<!-- There
   is a
   multi
   line
   comment -->

<p>There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph.</p>

<p>There is a paragraph. <!-- inline comment --><!-- inline
comment -->  <!-- inline comment -->There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph. There is a paragraph. There is a paragraph.
There is a paragraph.</p>

There is a paragraph. There is a paragraph. There is
a paragraph. <!-- inline comment --> There is a paragraph.
There is a paragraph. <!-- inline
comment --> There is a paragraph. There is a paragraph.
There is a paragraph.

<!-- There is a single line comment -->

There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph. <!-- There is a single line comment -->

There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph.
<!-- There is a single line comment -->

<!-- There is a single line comment -->
There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph. <!-- There is a single line comment -->

There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph.

<!-- There
   is a
   multi
   line
   comment -->

There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph.<!-- There
   is a
   multi
   line
   comment -->

<!-- There
   is a
   multi
   line
   comment -->
There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph.

There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph.

<!-- There
   is a
   multi
   line
   comment -->
<!-- There
   is a
   multi
   line
   comment -->

There is a paragraph. There is a paragraph. There is
a paragraph. There is a paragraph. There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph.

There is a paragraph. <!-- inline comment --><!-- inline
comment -->  <!-- inline comment -->There is a paragraph.
There is a paragraph. There is a paragraph. There is a
paragraph. There is a paragraph. There is a paragraph.
There is a paragraph.

<p>This code segment is indented with a tab</p>

<pre><code>#include &lt;stdio.h&gt;</code></pre>

<p>This code segment is indented with four spaces</p>

<pre><code>#include &lt;stdio.h&gt;</code></pre>

This code segment is indented with a tab

	#include <stdio.h>

This code segment is indented with four spaces

    #include <stdio.h>

<h1>Test inline Elements</h1>

<h2>Emphasis</h2>

<p>This one is <em>emphasized</em> with <code>*</code>. This one is <strong>strongly emphasized</strong> with <code>__</code>.
This one has its delimiter <em>e*s*c*a*p*e*d</em> as content. This is a free * 
asterisk and a free _ underscore. This is a <strong>strong one</strong>.</p>

<h2>Links</h2>

<p>Use <a href="http://www.google.de" title="Google Homepage">Google</a> and <a href="http://www.yahoo.com">Yahoo</a> for search and read <a href="http://slashdot.org" title="News for Nerds">News for Nerds</a> and
<a href="http://news.ycombinator.com" title="Hacker News">Hacker News</a>. Watch videos at <a href="http://www.youtube.com" title="Youtube">Youtube</a>.
<a href="http://slashdot.org" title="News for Nerds">News for Nerds</a>.</p>



<p>Unknown ref: [bla][foo]</p>

<h2>Code</h2>

<p>An XML declaration looks like this: <code>&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;</code>.
The  <code>printf()</code> function is used for printing to the screen. Show a single
<code>`</code>.</p>

<h2>Images</h2>

<p>Here comes an inline graphic <img src="/path/to/some.jpg" alt="Inline Image" title="Inline
title"/>. Here comes a reference <img src="/path/to/some.png" alt="Ref Image" title="Ref image title"/>.</p>



<h2>Entities</h2>

<p>Here is a copyright symbol: &copy;. AT&amp;T operator talk. 4 &lt; 5 or 5 &gt; 4.</p>

<h2>Automatic Links</h2>

<p>Write to <a href="mailto:[email protected]">[email protected]</a> and visit <a href="http://www.example.com">http://www.example.com</a>.
This is an auto-link with ampersand: <a href="http://example.com/?foo=1&amp;bar=2">http://example.com/?foo=1&amp;bar=2</a>.</p>

<h2>Inline HTML</h2>

<p>Here is some text <b>in bold</b>. An image tag <img src="nonexist.jpg" alt="no
such file"/>. And here comes a table:</p>

<table style="border: 1px solid black; border-collapse: collapse">
<tr>
  <td style="border-right: 1px solid red;"><b>Column A</b></td><td><b>Column B</b></td>
</tr>
</table>

<p>Here comes some text. Here comes some text. Here comes some text. Here
comes some text. Here comes some text. Here comes some text. Here comes
some text.</p>

<p>Here is an inline email link with mailto: <a href="mailto:[email protected]">[email protected]</a>. And
here is an inline email link without mailto: <a href="mailto:[email protected]">[email protected]</a>. This is
not a valid email link &lt;something@&gt; neither is this &lt;@example.com&gt;.</p>

Test inline Elements
===

Emphasis
---


This one is *emphasized* with `*`. This one is __strongly emphasized__ with `__`.
This one has its delimiter *e\*s\*c\*a\*p\*e\*d* as content. This is a free * 
asterisk and a free _ underscore. This is a **strong one**.

Links
---

Use [Google][] and [Yahoo] [] for search and read [News for Nerds][Slashdot] and
[Hacker News] [HN]. Watch videos at [Youtube](http://www.youtube.com "Youtube").
[News for Nerds][Slashdot].

[Google]:   http://www.google.de        
    "Google Homepage"
[Yahoo]:    http://www.yahoo.com
[Slashdot]: <http://slashdot.org>       (News for Nerds)
[HN]:       http://news.ycombinator.com 'Hacker News'

Unknown ref: [bla][foo]

Code
---

An XML declaration looks like this: `<?xml version="1.0" encoding="utf-8"?>`.
The  `printf()` function is used for printing to the screen. Show a single
`` ` ``.

Images
---

Here comes an inline graphic ![Inline Image](/path/to/some.jpg "Inline
title"). Here comes a reference ![Ref Image][SomeImage].

[SomeImage]: /path/to/some.png "Ref image title"

Entities
---

Here is a copyright symbol: &copy;. AT&T operator talk. 4 < 5 or 5 > 4.

Automatic Links
---

Write to <[email protected]> and visit <http://www.example.com>.
This is an auto-link with ampersand: <http://example.com/?foo=1&bar=2>.

Inline HTML
---

Here is some text <b>in bold</b>. An image tag <img src="nonexist.jpg" alt="no
such file"/>. And here comes a table:

<table style="border: 1px solid black; border-collapse: collapse">
<tr>
  <td style="border-right: 1px solid red;"><b>Column A</b></td><td><b>Column B</b></td>
</tr>
</table>

Here comes some text. Here comes some text. Here comes some text. Here
comes some text. Here comes some text. Here comes some text. Here comes
some text.

Here is an inline email link with mailto: <mailto:[email protected]>. And
here is an inline email link without mailto: <[email protected]>. This is
not a valid email link <something@> neither is this <@example.com>.

<p>This is a paragraph of test followed by a list. This is
a paragraph of text followed by a list. This is a paragraph
of text followed by a list. This is a paragraph of text.</p>

<ul>
<li><p>This is
a test</p>

<p>This is a 
test</p>

<ul>
<li>Bla blubber
bla blubber</li>
<li>Blubber bla
Blubbb...
</li></ul>

</li>
<li><p>A</p></li>
<li><p>B</p>

</li>
<li><p>C</p></li>
<li>D
</li></ul>

<ol>
<li><p>test</p><ul>
<li>a</li>
<li>b
</li></ul>

</li>
<li><p>test</p><ol>
<li><p>test</p>

</li>
<li><p>test</p>

</li></ol>

</li>
<li><p>test</p><ol>
<li>test</li>
<li>test
</li></ol>

</li></ol>

<ul>
<li><p>Another list</p>

<blockquote>
<p>Quote me
me me me</p>

<p>Quote me
me me me</p>

<blockquote>
<p>Quote quote me</p>
</blockquote>
</blockquote>

<p>Normal paragraph</p>

<pre><code>import os
os.path.listdir()</code></pre>

<ol>
<li><p>eins</p>

</li>
<li><p>zwei</p><ul>
<li>a</li>
<li>b
</li></ul>

</li></ol>

</li></ul>

<hr/>

<ul>
<li>test
<ul>
<li>test</li>
<li>test
</li></ul>

</li></ul>

<hr/>

<ul>
<li><p>This is a list item with two paragraphs.</p>

<p>This is the second paragraph in the list item. You&apos;re
only required to indent the first line. Lorem ipsum dolor
sit amet, consectetuer adipiscing elit.</p>

</li>
<li><p>Another item in the same list.</p>

</li></ul>

<ol>
<li>1. 1. Test that this does not recurse

</li></ol>

<ul>
<li><p>* * Test that this does not recurse</p>

</li>
<li><p>- - Test that this does not recurse</p>

</li>
<li><p>+ + Test that this does not recurse</p></li></ul>

This is a paragraph of test followed by a list. This is
a paragraph of text followed by a list. This is a paragraph
of text followed by a list. This is a paragraph of text.

* This is
a test

    This is a 
test

    * Bla blubber
    bla blubber
    * Blubber bla
    Blubbb...

* A
* B

* C
* D

1. test
    * a
    * b

2. test
    1. test

    2. test

3. test
    1. test
    2. test

* Another list

    > Quote me
    me me me

    > Quote me
    me me me

    > > Quote quote me

    Normal paragraph

        import os
        os.path.listdir()

    1. eins

    2. zwei
        * a
        * b

***

* test
    * test
    * test

***

*   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.


1. 1. 1. Test that this does not recurse


* * * Test that this does not recurse

- - - Test that this does not recurse

+ + + Test that this does not recurse

<h1>H1 Setext style heading</h1>

<p>This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a<br/>
paragraph of text.</p>

<h2>H2 Setext style heading</h2>

<p>This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.</p>

<h1>H1 Atx style heading</h1>

<p>This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.</p>

<h2>H2 Atx style heading</h2>

<p>This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.</p>

<h3>H3 Atx style heading</h3>

<p>This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.</p>

<h4>H4 Atx style heading</h4>

<p>This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.</p>

<h5>H5 Atx style heading</h5>

<p>This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.</p>

<h6>H6 Atx style heading</h6>

<p>This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.</p>

<hr/>

<p>This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.</p>

<hr/>

<p>This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.</p>

<hr/>

<p>This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.</p>

H1 Setext style heading
====



This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a  
paragraph of text.


H2 Setext style heading
----


This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.


# H1 Atx style heading




This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.

## H2 Atx style heading

This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.

### H3 Atx style heading

This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.

#### H4 Atx style heading

This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.

##### H5 Atx style heading

This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.

###### H6 Atx style heading

This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.

   - - -

This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.

 * * *

This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.

 _  ____

This is a paragraph of text. This is a paragraph
of text. This is a paragraph of text. This is a
paragraph of text.