From 77aed9225bc0fbb90459a2ead7d99de9aaf1796f Mon Sep 17 00:00:00 2001 From: Yuri Takhteyev Date: Tue, 26 Aug 2008 00:30:10 -0700 Subject: Adding old MarkdownTest.pl tests. --- MarkdownTest/MarkdownTest.pl | 165 ++++ MarkdownTest/Tests/Amps and angle encoding.html | 17 + MarkdownTest/Tests/Amps and angle encoding.text | 21 + MarkdownTest/Tests/Auto links.html | 18 + MarkdownTest/Tests/Auto links.text | 13 + MarkdownTest/Tests/Backslash escapes.html | 118 +++ MarkdownTest/Tests/Backslash escapes.text | 120 +++ .../Tests/Blockquotes with code blocks.html | 15 + .../Tests/Blockquotes with code blocks.text | 11 + MarkdownTest/Tests/Code Blocks.html | 18 + MarkdownTest/Tests/Code Blocks.text | 14 + MarkdownTest/Tests/Code Spans.html | 5 + MarkdownTest/Tests/Code Spans.text | 5 + ...rd-wrapped paragraphs with list-like lines.html | 8 + ...rd-wrapped paragraphs with list-like lines.text | 8 + MarkdownTest/Tests/Horizontal rules.html | 71 ++ MarkdownTest/Tests/Horizontal rules.text | 67 ++ MarkdownTest/Tests/Images.html | 21 + MarkdownTest/Tests/Images.text | 26 + MarkdownTest/Tests/Inline HTML (Advanced).html | 30 + MarkdownTest/Tests/Inline HTML (Advanced).text | 30 + MarkdownTest/Tests/Inline HTML (Simple).html | 72 ++ MarkdownTest/Tests/Inline HTML (Simple).text | 69 ++ MarkdownTest/Tests/Inline HTML comments.html | 13 + MarkdownTest/Tests/Inline HTML comments.text | 13 + MarkdownTest/Tests/Links, inline style.html | 23 + MarkdownTest/Tests/Links, inline style.text | 24 + MarkdownTest/Tests/Links, reference style.html | 52 ++ MarkdownTest/Tests/Links, reference style.text | 71 ++ MarkdownTest/Tests/Links, shortcut references.html | 9 + MarkdownTest/Tests/Links, shortcut references.text | 20 + MarkdownTest/Tests/Literal quotes in titles.html | 3 + MarkdownTest/Tests/Literal quotes in titles.text | 7 + .../Tests/Markdown Documentation - Basics.html | 314 +++++++ .../Tests/Markdown Documentation - Basics.text | 306 +++++++ .../Tests/Markdown Documentation - Syntax.html | 942 ++++++++++++++++++++ .../Tests/Markdown Documentation - Syntax.text | 888 +++++++++++++++++++ MarkdownTest/Tests/Nested blockquotes.html | 9 + MarkdownTest/Tests/Nested blockquotes.text | 5 + .../Tests/Ordered and unordered lists.html | 148 ++++ .../Tests/Ordered and unordered lists.text | 131 +++ MarkdownTest/Tests/Strong and em together.html | 7 + MarkdownTest/Tests/Strong and em together.text | 7 + MarkdownTest/Tests/Tabs.html | 25 + MarkdownTest/Tests/Tabs.text | 21 + MarkdownTest/Tests/Tidyness.html | 8 + MarkdownTest/Tests/Tidyness.text | 5 + .../Tests_2004/Amps and angle encoding.html | 17 + .../Tests_2004/Amps and angle encoding.text | 21 + .../Tests_2004/Amps and angle encoding.text-out | 21 + .../Tests_2004/Amps and angle encoding.text-res | 21 + MarkdownTest/Tests_2004/Auto links.html | 18 + MarkdownTest/Tests_2004/Auto links.text | 13 + MarkdownTest/Tests_2004/Auto links.text-out | 28 + MarkdownTest/Tests_2004/Auto links.text-res | 28 + MarkdownTest/Tests_2004/Backslash escapes.html | 102 +++ MarkdownTest/Tests_2004/Backslash escapes.text | 104 +++ MarkdownTest/Tests_2004/Backslash escapes.text-out | 79 ++ MarkdownTest/Tests_2004/Backslash escapes.text-res | 79 ++ .../Tests_2004/Blockquotes with code blocks.html | 15 + .../Tests_2004/Blockquotes with code blocks.text | 11 + .../Blockquotes with code blocks.text-out | 25 + .../Blockquotes with code blocks.text-res | 25 + ...rd-wrapped paragraphs with list-like lines.html | 8 + ...rd-wrapped paragraphs with list-like lines.text | 8 + ...rapped paragraphs with list-like lines.text-out | 14 + ...rapped paragraphs with list-like lines.text-res | 14 + MarkdownTest/Tests_2004/Horizontal rules.html | 71 ++ MarkdownTest/Tests_2004/Horizontal rules.text | 67 ++ MarkdownTest/Tests_2004/Horizontal rules.text-out | 61 ++ MarkdownTest/Tests_2004/Horizontal rules.text-res | 61 ++ .../Tests_2004/Inline HTML (Advanced).html | 14 + .../Tests_2004/Inline HTML (Advanced).text | 14 + .../Tests_2004/Inline HTML (Advanced).text-out | 19 + .../Tests_2004/Inline HTML (Advanced).text-res | 19 + MarkdownTest/Tests_2004/Inline HTML (Simple).html | 72 ++ MarkdownTest/Tests_2004/Inline HTML (Simple).text | 69 ++ .../Tests_2004/Inline HTML (Simple).text-out | 59 ++ .../Tests_2004/Inline HTML (Simple).text-res | 59 ++ MarkdownTest/Tests_2004/Inline HTML comments.html | 13 + MarkdownTest/Tests_2004/Inline HTML comments.text | 13 + .../Tests_2004/Inline HTML comments.text-out | 18 + .../Tests_2004/Inline HTML comments.text-res | 18 + MarkdownTest/Tests_2004/Links, inline style.html | 9 + MarkdownTest/Tests_2004/Links, inline style.text | 9 + .../Tests_2004/Links, inline style.text-out | 17 + .../Tests_2004/Links, inline style.text-res | 17 + .../Tests_2004/Links, reference style.html | 18 + .../Tests_2004/Links, reference style.text | 31 + .../Tests_2004/Links, reference style.text-out | 22 + .../Tests_2004/Links, reference style.text-res | 22 + MarkdownTest/Tests_2004/Links-in-Headers.text-out | 9 + MarkdownTest/Tests_2004/Links-in-Headers.text-res | 9 + .../Tests_2004/Literal quotes in titles.html | 3 + .../Tests_2004/Literal quotes in titles.text | 7 + .../Tests_2004/Literal quotes in titles.text-out | 14 + .../Tests_2004/Literal quotes in titles.text-res | 14 + .../Markdown Documentation - Basics.html | 314 +++++++ .../Markdown Documentation - Basics.text | 306 +++++++ .../Markdown Documentation - Basics.text-out | 321 +++++++ .../Markdown Documentation - Basics.text-res | 321 +++++++ .../Markdown Documentation - Syntax.html | 942 ++++++++++++++++++++ .../Markdown Documentation - Syntax.text | 888 +++++++++++++++++++ .../Markdown Documentation - Syntax.text-out | 957 +++++++++++++++++++++ .../Markdown Documentation - Syntax.text-res | 957 +++++++++++++++++++++ MarkdownTest/Tests_2004/Nested blockquotes.html | 9 + MarkdownTest/Tests_2004/Nested blockquotes.text | 5 + .../Tests_2004/Nested blockquotes.text-out | 17 + .../Tests_2004/Nested blockquotes.text-res | 17 + .../Tests_2004/Ordered and unordered lists.html | 137 +++ .../Tests_2004/Ordered and unordered lists.text | 122 +++ .../Ordered and unordered lists.text-out | 159 ++++ .../Ordered and unordered lists.text-res | 159 ++++ .../Tests_2004/Strong and em together.html | 7 + .../Tests_2004/Strong and em together.text | 7 + .../Tests_2004/Strong and em together.text-out | 14 + .../Tests_2004/Strong and em together.text-res | 14 + MarkdownTest/Tests_2004/Tabs.html | 25 + MarkdownTest/Tests_2004/Tabs.text | 21 + MarkdownTest/Tests_2004/Tabs.text-out | 37 + MarkdownTest/Tests_2004/Tabs.text-res | 37 + MarkdownTest/Tests_2004/Tidyness.html | 8 + MarkdownTest/Tests_2004/Tidyness.text | 5 + MarkdownTest/Tests_2004/Tidyness.text-out | 18 + MarkdownTest/Tests_2004/Tidyness.text-res | 18 + MarkdownTest/Tests_2004/Yuri-Attributes.html | 28 + MarkdownTest/Tests_2004/Yuri-Attributes.text | 19 + MarkdownTest/Tests_2004/Yuri-Attributes.text-out | 29 + MarkdownTest/Tests_2004/Yuri-Attributes.text-res | 29 + MarkdownTest/Tests_2004/Yuri-Attributes.text~ | 24 + MarkdownTest/Tests_2004/Yuri-Email.html | 18 + MarkdownTest/Tests_2004/Yuri-Email.text | 7 + MarkdownTest/Tests_2004/Yuri-Email.text-out | 17 + MarkdownTest/Tests_2004/Yuri-Email.text-res | 17 + MarkdownTest/Tests_2004/Yuri-Footnotes.html | 46 + MarkdownTest/Tests_2004/Yuri-Footnotes.text | 32 + MarkdownTest/Tests_2004/Yuri-Footnotes.text-out | 42 + MarkdownTest/Tests_2004/Yuri-Footnotes.text-res | 55 ++ MarkdownTest/Tests_2004/Yuri-Links-in-Headers.html | 15 + MarkdownTest/Tests_2004/Yuri-Links-in-Headers.text | 18 + .../Tests_2004/Yuri-Links-in-Headers.text-out | 18 + .../Tests_2004/Yuri-Links-in-Headers.text-res | 18 + MarkdownTest/readme.txt | 1 + 143 files changed, 11767 insertions(+) create mode 100755 MarkdownTest/MarkdownTest.pl create mode 100644 MarkdownTest/Tests/Amps and angle encoding.html create mode 100644 MarkdownTest/Tests/Amps and angle encoding.text create mode 100644 MarkdownTest/Tests/Auto links.html create mode 100644 MarkdownTest/Tests/Auto links.text create mode 100644 MarkdownTest/Tests/Backslash escapes.html create mode 100644 MarkdownTest/Tests/Backslash escapes.text create mode 100644 MarkdownTest/Tests/Blockquotes with code blocks.html create mode 100644 MarkdownTest/Tests/Blockquotes with code blocks.text create mode 100644 MarkdownTest/Tests/Code Blocks.html create mode 100644 MarkdownTest/Tests/Code Blocks.text create mode 100644 MarkdownTest/Tests/Code Spans.html create mode 100644 MarkdownTest/Tests/Code Spans.text create mode 100644 MarkdownTest/Tests/Hard-wrapped paragraphs with list-like lines.html create mode 100644 MarkdownTest/Tests/Hard-wrapped paragraphs with list-like lines.text create mode 100644 MarkdownTest/Tests/Horizontal rules.html create mode 100644 MarkdownTest/Tests/Horizontal rules.text create mode 100644 MarkdownTest/Tests/Images.html create mode 100644 MarkdownTest/Tests/Images.text create mode 100644 MarkdownTest/Tests/Inline HTML (Advanced).html create mode 100644 MarkdownTest/Tests/Inline HTML (Advanced).text create mode 100644 MarkdownTest/Tests/Inline HTML (Simple).html create mode 100644 MarkdownTest/Tests/Inline HTML (Simple).text create mode 100644 MarkdownTest/Tests/Inline HTML comments.html create mode 100644 MarkdownTest/Tests/Inline HTML comments.text create mode 100644 MarkdownTest/Tests/Links, inline style.html create mode 100644 MarkdownTest/Tests/Links, inline style.text create mode 100644 MarkdownTest/Tests/Links, reference style.html create mode 100644 MarkdownTest/Tests/Links, reference style.text create mode 100755 MarkdownTest/Tests/Links, shortcut references.html create mode 100755 MarkdownTest/Tests/Links, shortcut references.text create mode 100644 MarkdownTest/Tests/Literal quotes in titles.html create mode 100644 MarkdownTest/Tests/Literal quotes in titles.text create mode 100644 MarkdownTest/Tests/Markdown Documentation - Basics.html create mode 100644 MarkdownTest/Tests/Markdown Documentation - Basics.text create mode 100644 MarkdownTest/Tests/Markdown Documentation - Syntax.html create mode 100644 MarkdownTest/Tests/Markdown Documentation - Syntax.text create mode 100644 MarkdownTest/Tests/Nested blockquotes.html create mode 100644 MarkdownTest/Tests/Nested blockquotes.text create mode 100644 MarkdownTest/Tests/Ordered and unordered lists.html create mode 100644 MarkdownTest/Tests/Ordered and unordered lists.text create mode 100644 MarkdownTest/Tests/Strong and em together.html create mode 100644 MarkdownTest/Tests/Strong and em together.text create mode 100644 MarkdownTest/Tests/Tabs.html create mode 100644 MarkdownTest/Tests/Tabs.text create mode 100644 MarkdownTest/Tests/Tidyness.html create mode 100644 MarkdownTest/Tests/Tidyness.text create mode 100644 MarkdownTest/Tests_2004/Amps and angle encoding.html create mode 100644 MarkdownTest/Tests_2004/Amps and angle encoding.text create mode 100644 MarkdownTest/Tests_2004/Amps and angle encoding.text-out create mode 100644 MarkdownTest/Tests_2004/Amps and angle encoding.text-res create mode 100644 MarkdownTest/Tests_2004/Auto links.html create mode 100644 MarkdownTest/Tests_2004/Auto links.text create mode 100644 MarkdownTest/Tests_2004/Auto links.text-out create mode 100644 MarkdownTest/Tests_2004/Auto links.text-res create mode 100644 MarkdownTest/Tests_2004/Backslash escapes.html create mode 100644 MarkdownTest/Tests_2004/Backslash escapes.text create mode 100644 MarkdownTest/Tests_2004/Backslash escapes.text-out create mode 100644 MarkdownTest/Tests_2004/Backslash escapes.text-res create mode 100644 MarkdownTest/Tests_2004/Blockquotes with code blocks.html create mode 100644 MarkdownTest/Tests_2004/Blockquotes with code blocks.text create mode 100644 MarkdownTest/Tests_2004/Blockquotes with code blocks.text-out create mode 100644 MarkdownTest/Tests_2004/Blockquotes with code blocks.text-res create mode 100644 MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.html create mode 100644 MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.text create mode 100644 MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.text-out create mode 100644 MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.text-res create mode 100644 MarkdownTest/Tests_2004/Horizontal rules.html create mode 100644 MarkdownTest/Tests_2004/Horizontal rules.text create mode 100644 MarkdownTest/Tests_2004/Horizontal rules.text-out create mode 100644 MarkdownTest/Tests_2004/Horizontal rules.text-res create mode 100644 MarkdownTest/Tests_2004/Inline HTML (Advanced).html create mode 100644 MarkdownTest/Tests_2004/Inline HTML (Advanced).text create mode 100644 MarkdownTest/Tests_2004/Inline HTML (Advanced).text-out create mode 100644 MarkdownTest/Tests_2004/Inline HTML (Advanced).text-res create mode 100644 MarkdownTest/Tests_2004/Inline HTML (Simple).html create mode 100644 MarkdownTest/Tests_2004/Inline HTML (Simple).text create mode 100644 MarkdownTest/Tests_2004/Inline HTML (Simple).text-out create mode 100644 MarkdownTest/Tests_2004/Inline HTML (Simple).text-res create mode 100644 MarkdownTest/Tests_2004/Inline HTML comments.html create mode 100644 MarkdownTest/Tests_2004/Inline HTML comments.text create mode 100644 MarkdownTest/Tests_2004/Inline HTML comments.text-out create mode 100644 MarkdownTest/Tests_2004/Inline HTML comments.text-res create mode 100644 MarkdownTest/Tests_2004/Links, inline style.html create mode 100644 MarkdownTest/Tests_2004/Links, inline style.text create mode 100644 MarkdownTest/Tests_2004/Links, inline style.text-out create mode 100644 MarkdownTest/Tests_2004/Links, inline style.text-res create mode 100644 MarkdownTest/Tests_2004/Links, reference style.html create mode 100644 MarkdownTest/Tests_2004/Links, reference style.text create mode 100644 MarkdownTest/Tests_2004/Links, reference style.text-out create mode 100644 MarkdownTest/Tests_2004/Links, reference style.text-res create mode 100644 MarkdownTest/Tests_2004/Links-in-Headers.text-out create mode 100644 MarkdownTest/Tests_2004/Links-in-Headers.text-res create mode 100644 MarkdownTest/Tests_2004/Literal quotes in titles.html create mode 100644 MarkdownTest/Tests_2004/Literal quotes in titles.text create mode 100644 MarkdownTest/Tests_2004/Literal quotes in titles.text-out create mode 100644 MarkdownTest/Tests_2004/Literal quotes in titles.text-res create mode 100644 MarkdownTest/Tests_2004/Markdown Documentation - Basics.html create mode 100644 MarkdownTest/Tests_2004/Markdown Documentation - Basics.text create mode 100644 MarkdownTest/Tests_2004/Markdown Documentation - Basics.text-out create mode 100644 MarkdownTest/Tests_2004/Markdown Documentation - Basics.text-res create mode 100644 MarkdownTest/Tests_2004/Markdown Documentation - Syntax.html create mode 100644 MarkdownTest/Tests_2004/Markdown Documentation - Syntax.text create mode 100644 MarkdownTest/Tests_2004/Markdown Documentation - Syntax.text-out create mode 100644 MarkdownTest/Tests_2004/Markdown Documentation - Syntax.text-res create mode 100644 MarkdownTest/Tests_2004/Nested blockquotes.html create mode 100644 MarkdownTest/Tests_2004/Nested blockquotes.text create mode 100644 MarkdownTest/Tests_2004/Nested blockquotes.text-out create mode 100644 MarkdownTest/Tests_2004/Nested blockquotes.text-res create mode 100644 MarkdownTest/Tests_2004/Ordered and unordered lists.html create mode 100644 MarkdownTest/Tests_2004/Ordered and unordered lists.text create mode 100644 MarkdownTest/Tests_2004/Ordered and unordered lists.text-out create mode 100644 MarkdownTest/Tests_2004/Ordered and unordered lists.text-res create mode 100644 MarkdownTest/Tests_2004/Strong and em together.html create mode 100644 MarkdownTest/Tests_2004/Strong and em together.text create mode 100644 MarkdownTest/Tests_2004/Strong and em together.text-out create mode 100644 MarkdownTest/Tests_2004/Strong and em together.text-res create mode 100644 MarkdownTest/Tests_2004/Tabs.html create mode 100644 MarkdownTest/Tests_2004/Tabs.text create mode 100644 MarkdownTest/Tests_2004/Tabs.text-out create mode 100644 MarkdownTest/Tests_2004/Tabs.text-res create mode 100644 MarkdownTest/Tests_2004/Tidyness.html create mode 100644 MarkdownTest/Tests_2004/Tidyness.text create mode 100644 MarkdownTest/Tests_2004/Tidyness.text-out create mode 100644 MarkdownTest/Tests_2004/Tidyness.text-res create mode 100644 MarkdownTest/Tests_2004/Yuri-Attributes.html create mode 100644 MarkdownTest/Tests_2004/Yuri-Attributes.text create mode 100644 MarkdownTest/Tests_2004/Yuri-Attributes.text-out create mode 100644 MarkdownTest/Tests_2004/Yuri-Attributes.text-res create mode 100644 MarkdownTest/Tests_2004/Yuri-Attributes.text~ create mode 100644 MarkdownTest/Tests_2004/Yuri-Email.html create mode 100644 MarkdownTest/Tests_2004/Yuri-Email.text create mode 100644 MarkdownTest/Tests_2004/Yuri-Email.text-out create mode 100644 MarkdownTest/Tests_2004/Yuri-Email.text-res create mode 100644 MarkdownTest/Tests_2004/Yuri-Footnotes.html create mode 100644 MarkdownTest/Tests_2004/Yuri-Footnotes.text create mode 100644 MarkdownTest/Tests_2004/Yuri-Footnotes.text-out create mode 100644 MarkdownTest/Tests_2004/Yuri-Footnotes.text-res create mode 100644 MarkdownTest/Tests_2004/Yuri-Links-in-Headers.html create mode 100644 MarkdownTest/Tests_2004/Yuri-Links-in-Headers.text create mode 100644 MarkdownTest/Tests_2004/Yuri-Links-in-Headers.text-out create mode 100644 MarkdownTest/Tests_2004/Yuri-Links-in-Headers.text-res create mode 100644 MarkdownTest/readme.txt (limited to 'MarkdownTest') diff --git a/MarkdownTest/MarkdownTest.pl b/MarkdownTest/MarkdownTest.pl new file mode 100755 index 0000000..8e7048f --- /dev/null +++ b/MarkdownTest/MarkdownTest.pl @@ -0,0 +1,165 @@ +#!/usr/bin/perl + +# +# MarkdownTester -- Run tests for Markdown implementations +# +# Copyright (c) 2004-2005 John Gruber +# +# + +use strict; +use warnings; +use Getopt::Long; +use Benchmark; + +our $VERSION = '1.0.2'; +# Sat 24 Dec 2005 + +my $time_start = new Benchmark; +my $test_dir = "Tests"; +my $script = "./Markdown.pl"; +my $use_tidy = 0; +my ($flag_version); + +GetOptions ( + "script=s" => \$script, + "testdir=s" => \$test_dir, + "tidy" => \$use_tidy, + "version" => \$flag_version, + ); + +if($flag_version) { + my $progname = $0; + $progname =~ s{.*/}{}; + die "$progname version $VERSION\n"; +} + +unless (-d $test_dir) { die "'$test_dir' is not a directory.\n"; } +unless (-f $script) { die "$script does not exist.\n"; } +unless (-x $script) { die "$script is not executable.\n"; } + +my $tests_passed = 0; +my $tests_failed = 0; + +TEST: +foreach my $testfile (glob "$test_dir/*.text") { + my $testname = $testfile; + $testname =~ s{.*/(.+)\.text$}{$1}i; + print "$testname ... "; + + # Look for a corresponding .html file for each .text file: + my $resultfile = $testfile; + $resultfile =~ s{\.text$}{\.html}i; + unless (-f $resultfile) { + print "'$resultfile' does not exist.\n\n"; + next TEST; + } + + # open(TEST, $testfile) || die("Can't open testfile: $!"); + open(RESULT, $resultfile) || die("Can't open resultfile: $!"); + undef $/; + # my $t_input = ; + my $t_result = ; + + my $t_output = `'$script' '$testfile'`; + + # Normalize the output and expected result strings: + $t_result =~ s/\s+\z//; # trim trailing whitespace + $t_output =~ s/\s+\z//; # trim trailing whitespace + if ($use_tidy) { + # Escape the strings, pass them through to CLI tidy tool for tag-level equivalency + $t_result =~ s{'}{'\\''}g; # escape ' chars for shell + $t_output =~ s{'}{'\\''}g; + $t_result = `echo '$t_result' | tidy -quiet --show-warnings n`; + $t_output = `echo '$t_output' | tidy -quiet --show-warnings n`; + } + + if ($t_output eq $t_result) { + print "OK\n"; + $tests_passed++; + } + else { + print "FAILED\n\n"; + $tests_failed++; + } +} + +print "\n\n"; +print "$tests_passed passed; $tests_failed failed.\n"; + +my $time_end = new Benchmark; +my $time_diff = timediff($time_end, $time_start); +print "Benchmark: ", timestr($time_diff), "\n"; + + +__END__ + +=pod + +=head1 NAME + +B + + +=head1 SYNOPSIS + +B [ B<--options> ] [ I ... ] + + +=head1 DESCRIPTION + + +=head1 OPTIONS + +Use "--" to end switch parsing. For example, to open a file named "-z", use: + + MarkdownTest.pl -- -z + +=over 4 + +=item B<--script> + +Specify the path to the Markdown script to test. Defaults to +"./Markdown.pl". Example: + + ./MarkdownTest.pl --script ./PHP-Markdown/php-markdown + +=item B<--testdir> + +Specify the path to a directory containing test data. Defaults to "Tests". + +=item B<--tidy> + +Flag to turn on using the command line 'tidy' tool to normalize HTML +output before comparing script output to the expected test result. +Assumes that the 'tidy' command is available in your PATH. Defaults to +off. + +=back + + + +=head1 BUGS + + + +=head1 VERSION HISTORY + +1.0 Mon 13 Dec 2004-2005 + +1.0.1 Mon 19 Sep 2005 + + + Better handling of case when foo.text exists, but foo.html doesn't. + It now prints a message and moves on, rather than dying. + + +=head1 COPYRIGHT AND LICENSE + +Copyright (c) 2004-2005 John Gruber + +All rights reserved. + +This is free software; you may redistribute it and/or modify it under +the same terms as Perl itself. + +=cut diff --git a/MarkdownTest/Tests/Amps and angle encoding.html b/MarkdownTest/Tests/Amps and angle encoding.html new file mode 100644 index 0000000..9606860 --- /dev/null +++ b/MarkdownTest/Tests/Amps and angle encoding.html @@ -0,0 +1,17 @@ +

AT&T has an ampersand in their name.

+ +

AT&T is another way to write it.

+ +

This & that.

+ +

4 < 5.

+ +

6 > 5.

+ +

Here's a link with an ampersand in the URL.

+ +

Here's a link with an amersand in the link text: AT&T.

+ +

Here's an inline link.

+ +

Here's an inline link.

diff --git a/MarkdownTest/Tests/Amps and angle encoding.text b/MarkdownTest/Tests/Amps and angle encoding.text new file mode 100644 index 0000000..0e9527f --- /dev/null +++ b/MarkdownTest/Tests/Amps and angle encoding.text @@ -0,0 +1,21 @@ +AT&T has an ampersand in their name. + +AT&T is another way to write it. + +This & that. + +4 < 5. + +6 > 5. + +Here's a [link] [1] with an ampersand in the URL. + +Here's a link with an amersand in the link text: [AT&T] [2]. + +Here's an inline [link](/script?foo=1&bar=2). + +Here's an inline [link](). + + +[1]: http://example.com/?foo=1&bar=2 +[2]: http://att.com/ "AT&T" \ No newline at end of file diff --git a/MarkdownTest/Tests/Auto links.html b/MarkdownTest/Tests/Auto links.html new file mode 100644 index 0000000..f8df985 --- /dev/null +++ b/MarkdownTest/Tests/Auto links.html @@ -0,0 +1,18 @@ +

Link: http://example.com/.

+ +

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

+ + + +
+

Blockquoted: http://example.com/

+
+ +

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

+ +
or here: <http://example.com/>
+
diff --git a/MarkdownTest/Tests/Auto links.text b/MarkdownTest/Tests/Auto links.text new file mode 100644 index 0000000..abbc488 --- /dev/null +++ b/MarkdownTest/Tests/Auto links.text @@ -0,0 +1,13 @@ +Link: . + +With an ampersand: + +* In a list? +* +* It should. + +> Blockquoted: + +Auto-links should not occur here: `` + + or here: \ No newline at end of file diff --git a/MarkdownTest/Tests/Backslash escapes.html b/MarkdownTest/Tests/Backslash escapes.html new file mode 100644 index 0000000..29870da --- /dev/null +++ b/MarkdownTest/Tests/Backslash escapes.html @@ -0,0 +1,118 @@ +

These should all get escaped:

+ +

Backslash: \

+ +

Backtick: `

+ +

Asterisk: *

+ +

Underscore: _

+ +

Left brace: {

+ +

Right brace: }

+ +

Left bracket: [

+ +

Right bracket: ]

+ +

Left paren: (

+ +

Right paren: )

+ +

Greater-than: >

+ +

Hash: #

+ +

Period: .

+ +

Bang: !

+ +

Plus: +

+ +

Minus: -

+ +

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

+ +
Backslash: \\
+
+Backtick: \`
+
+Asterisk: \*
+
+Underscore: \_
+
+Left brace: \{
+
+Right brace: \}
+
+Left bracket: \[
+
+Right bracket: \]
+
+Left paren: \(
+
+Right paren: \)
+
+Greater-than: \>
+
+Hash: \#
+
+Period: \.
+
+Bang: \!
+
+Plus: \+
+
+Minus: \-
+
+ +

Nor should these, which occur in code spans:

+ +

Backslash: \\

+ +

Backtick: \`

+ +

Asterisk: \*

+ +

Underscore: \_

+ +

Left brace: \{

+ +

Right brace: \}

+ +

Left bracket: \[

+ +

Right bracket: \]

+ +

Left paren: \(

+ +

Right paren: \)

+ +

Greater-than: \>

+ +

Hash: \#

+ +

Period: \.

+ +

Bang: \!

+ +

Plus: \+

+ +

Minus: \-

+ + +

These should get escaped, even though they're matching pairs for +other Markdown constructs:

+ +

*asterisks*

+ +

_underscores_

+ +

`backticks`

+ +

This is a code span with a literal backslash-backtick sequence: \`

+ +

This is a tag with unescaped backticks bar.

+ +

This is a tag with backslashes bar.

diff --git a/MarkdownTest/Tests/Backslash escapes.text b/MarkdownTest/Tests/Backslash escapes.text new file mode 100644 index 0000000..5b014cb --- /dev/null +++ b/MarkdownTest/Tests/Backslash escapes.text @@ -0,0 +1,120 @@ +These should all get escaped: + +Backslash: \\ + +Backtick: \` + +Asterisk: \* + +Underscore: \_ + +Left brace: \{ + +Right brace: \} + +Left bracket: \[ + +Right bracket: \] + +Left paren: \( + +Right paren: \) + +Greater-than: \> + +Hash: \# + +Period: \. + +Bang: \! + +Plus: \+ + +Minus: \- + + + +These should not, because they occur within a code block: + + Backslash: \\ + + Backtick: \` + + Asterisk: \* + + Underscore: \_ + + Left brace: \{ + + Right brace: \} + + Left bracket: \[ + + Right bracket: \] + + Left paren: \( + + Right paren: \) + + Greater-than: \> + + Hash: \# + + Period: \. + + Bang: \! + + Plus: \+ + + Minus: \- + + +Nor should these, which occur in code spans: + +Backslash: `\\` + +Backtick: `` \` `` + +Asterisk: `\*` + +Underscore: `\_` + +Left brace: `\{` + +Right brace: `\}` + +Left bracket: `\[` + +Right bracket: `\]` + +Left paren: `\(` + +Right paren: `\)` + +Greater-than: `\>` + +Hash: `\#` + +Period: `\.` + +Bang: `\!` + +Plus: `\+` + +Minus: `\-` + + +These should get escaped, even though they're matching pairs for +other Markdown constructs: + +\*asterisks\* + +\_underscores\_ + +\`backticks\` + +This is a code span with a literal backslash-backtick sequence: `` \` `` + +This is a tag with unescaped backticks bar. + +This is a tag with backslashes bar. diff --git a/MarkdownTest/Tests/Blockquotes with code blocks.html b/MarkdownTest/Tests/Blockquotes with code blocks.html new file mode 100644 index 0000000..990202a --- /dev/null +++ b/MarkdownTest/Tests/Blockquotes with code blocks.html @@ -0,0 +1,15 @@ +
+

Example:

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

Or:

+ +
sub status {
+    return "working";
+}
+
+
diff --git a/MarkdownTest/Tests/Blockquotes with code blocks.text b/MarkdownTest/Tests/Blockquotes with code blocks.text new file mode 100644 index 0000000..c31d171 --- /dev/null +++ b/MarkdownTest/Tests/Blockquotes with code blocks.text @@ -0,0 +1,11 @@ +> Example: +> +> sub status { +> print "working"; +> } +> +> Or: +> +> sub status { +> return "working"; +> } diff --git a/MarkdownTest/Tests/Code Blocks.html b/MarkdownTest/Tests/Code Blocks.html new file mode 100644 index 0000000..32703f5 --- /dev/null +++ b/MarkdownTest/Tests/Code Blocks.html @@ -0,0 +1,18 @@ +
code block on the first line
+
+ +

Regular text.

+ +
code block indented by spaces
+
+ +

Regular text.

+ +
the lines in this block  
+all contain trailing spaces  
+
+ +

Regular Text.

+ +
code block on the last line
+
diff --git a/MarkdownTest/Tests/Code Blocks.text b/MarkdownTest/Tests/Code Blocks.text new file mode 100644 index 0000000..b54b092 --- /dev/null +++ b/MarkdownTest/Tests/Code Blocks.text @@ -0,0 +1,14 @@ + code block on the first line + +Regular text. + + code block indented by spaces + +Regular text. + + the lines in this block + all contain trailing spaces + +Regular Text. + + code block on the last line \ No newline at end of file diff --git a/MarkdownTest/Tests/Code Spans.html b/MarkdownTest/Tests/Code Spans.html new file mode 100644 index 0000000..b057457 --- /dev/null +++ b/MarkdownTest/Tests/Code Spans.html @@ -0,0 +1,5 @@ +

<test a=" content of attribute ">

+ +

Fix for backticks within HTML tag: like this

+ +

Here's how you put `backticks` in a code span.

diff --git a/MarkdownTest/Tests/Code Spans.text b/MarkdownTest/Tests/Code Spans.text new file mode 100644 index 0000000..5c229c7 --- /dev/null +++ b/MarkdownTest/Tests/Code Spans.text @@ -0,0 +1,5 @@ +`` + +Fix for backticks within HTML tag: like this + +Here's how you put `` `backticks` `` in a code span. \ No newline at end of file diff --git a/MarkdownTest/Tests/Hard-wrapped paragraphs with list-like lines.html b/MarkdownTest/Tests/Hard-wrapped paragraphs with list-like lines.html new file mode 100644 index 0000000..e21ac79 --- /dev/null +++ b/MarkdownTest/Tests/Hard-wrapped paragraphs with list-like lines.html @@ -0,0 +1,8 @@ +

In Markdown 1.0.0 and earlier. Version +8. This line turns into a list item. +Because a hard-wrapped line in the +middle of a paragraph looked like a +list item.

+ +

Here's one with a bullet. +* criminey.

diff --git a/MarkdownTest/Tests/Hard-wrapped paragraphs with list-like lines.text b/MarkdownTest/Tests/Hard-wrapped paragraphs with list-like lines.text new file mode 100644 index 0000000..f8a5b27 --- /dev/null +++ b/MarkdownTest/Tests/Hard-wrapped paragraphs with list-like lines.text @@ -0,0 +1,8 @@ +In Markdown 1.0.0 and earlier. Version +8. This line turns into a list item. +Because a hard-wrapped line in the +middle of a paragraph looked like a +list item. + +Here's one with a bullet. +* criminey. diff --git a/MarkdownTest/Tests/Horizontal rules.html b/MarkdownTest/Tests/Horizontal rules.html new file mode 100644 index 0000000..2dc2ab6 --- /dev/null +++ b/MarkdownTest/Tests/Horizontal rules.html @@ -0,0 +1,71 @@ +

Dashes:

+ +
+ +
+ +
+ +
+ +
---
+
+ +
+ +
+ +
+ +
+ +
- - -
+
+ +

Asterisks:

+ +
+ +
+ +
+ +
+ +
***
+
+ +
+ +
+ +
+ +
+ +
* * *
+
+ +

Underscores:

+ +
+ +
+ +
+ +
+ +
___
+
+ +
+ +
+ +
+ +
+ +
_ _ _
+
diff --git a/MarkdownTest/Tests/Horizontal rules.text b/MarkdownTest/Tests/Horizontal rules.text new file mode 100644 index 0000000..1594bda --- /dev/null +++ b/MarkdownTest/Tests/Horizontal rules.text @@ -0,0 +1,67 @@ +Dashes: + +--- + + --- + + --- + + --- + + --- + +- - - + + - - - + + - - - + + - - - + + - - - + + +Asterisks: + +*** + + *** + + *** + + *** + + *** + +* * * + + * * * + + * * * + + * * * + + * * * + + +Underscores: + +___ + + ___ + + ___ + + ___ + + ___ + +_ _ _ + + _ _ _ + + _ _ _ + + _ _ _ + + _ _ _ diff --git a/MarkdownTest/Tests/Images.html b/MarkdownTest/Tests/Images.html new file mode 100644 index 0000000..217f028 --- /dev/null +++ b/MarkdownTest/Tests/Images.html @@ -0,0 +1,21 @@ +

Alt text

+ +

Alt text

+ +

Inline within a paragraph: alt text.

+ +

alt text

+ +

alt text

+ +

alt text

+ +

alt text.

+ +

Empty

+ +

this is a stupid URL

+ +

alt text

+ +

alt text

diff --git a/MarkdownTest/Tests/Images.text b/MarkdownTest/Tests/Images.text new file mode 100644 index 0000000..5707590 --- /dev/null +++ b/MarkdownTest/Tests/Images.text @@ -0,0 +1,26 @@ +![Alt text](/path/to/img.jpg) + +![Alt text](/path/to/img.jpg "Optional title") + +Inline within a paragraph: [alt text](/url/). + +![alt text](/url/ "title preceded by two spaces") + +![alt text](/url/ "title has spaces afterward" ) + +![alt text]() + +![alt text]( "with a title"). + +![Empty]() + +![this is a stupid URL](http://example.com/(parens).jpg) + + +![alt text][foo] + + [foo]: /url/ + +![alt text][bar] + + [bar]: /url/ "Title here" \ No newline at end of file diff --git a/MarkdownTest/Tests/Inline HTML (Advanced).html b/MarkdownTest/Tests/Inline HTML (Advanced).html new file mode 100644 index 0000000..884f14c --- /dev/null +++ b/MarkdownTest/Tests/Inline HTML (Advanced).html @@ -0,0 +1,30 @@ +

Simple block on one line:

+ +
foo
+ +

And nested without indentation:

+ +
+
+
+foo +
+
+
+
bar
+
+ +

And with attributes:

+ +
+
+
+
+ +

This was broken in 1.0.2b7:

+ +
+
+foo +
+
diff --git a/MarkdownTest/Tests/Inline HTML (Advanced).text b/MarkdownTest/Tests/Inline HTML (Advanced).text new file mode 100644 index 0000000..3633f81 --- /dev/null +++ b/MarkdownTest/Tests/Inline HTML (Advanced).text @@ -0,0 +1,30 @@ +Simple block on one line: + +
foo
+ +And nested without indentation: + +
+
+
+foo +
+
+
+
bar
+
+ +And with attributes: + +
+
+
+
+ +This was broken in 1.0.2b7: + +
+
+foo +
+
diff --git a/MarkdownTest/Tests/Inline HTML (Simple).html b/MarkdownTest/Tests/Inline HTML (Simple).html new file mode 100644 index 0000000..6bf78f8 --- /dev/null +++ b/MarkdownTest/Tests/Inline HTML (Simple).html @@ -0,0 +1,72 @@ +

Here's a simple block:

+ +
+ foo +
+ +

This should be a code block, though:

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

As should this:

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

Now, nested:

+ +
+
+
+ foo +
+
+
+ +

This should just be an HTML comment:

+ + + +

Multiline:

+ + + +

Code block:

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

Just plain comment, with trailing spaces on the line:

+ + + +

Code:

+ +
<hr />
+
+ +

Hr's:

+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
diff --git a/MarkdownTest/Tests/Inline HTML (Simple).text b/MarkdownTest/Tests/Inline HTML (Simple).text new file mode 100644 index 0000000..14aa2dc --- /dev/null +++ b/MarkdownTest/Tests/Inline HTML (Simple).text @@ -0,0 +1,69 @@ +Here's a simple block: + +
+ foo +
+ +This should be a code block, though: + +
+ foo +
+ +As should this: + +
foo
+ +Now, nested: + +
+
+
+ foo +
+
+
+ +This should just be an HTML comment: + + + +Multiline: + + + +Code block: + + + +Just plain comment, with trailing spaces on the line: + + + +Code: + +
+ +Hr's: + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ diff --git a/MarkdownTest/Tests/Inline HTML comments.html b/MarkdownTest/Tests/Inline HTML comments.html new file mode 100644 index 0000000..3f167a1 --- /dev/null +++ b/MarkdownTest/Tests/Inline HTML comments.html @@ -0,0 +1,13 @@ +

Paragraph one.

+ + + + + +

Paragraph two.

+ + + +

The end.

diff --git a/MarkdownTest/Tests/Inline HTML comments.text b/MarkdownTest/Tests/Inline HTML comments.text new file mode 100644 index 0000000..41d830d --- /dev/null +++ b/MarkdownTest/Tests/Inline HTML comments.text @@ -0,0 +1,13 @@ +Paragraph one. + + + + + +Paragraph two. + + + +The end. diff --git a/MarkdownTest/Tests/Links, inline style.html b/MarkdownTest/Tests/Links, inline style.html new file mode 100644 index 0000000..9f351ef --- /dev/null +++ b/MarkdownTest/Tests/Links, inline style.html @@ -0,0 +1,23 @@ +

Just a URL.

+ +

URL and title.

+ +

URL and title.

+ +

URL and title.

+ +

URL and title.

+ +

URL wrapped in angle brackets.

+ +

URL w/ angle brackets + title.

+ +

Empty.

+ +

With parens in the URL

+ +

(With outer parens and parens in url)

+ +

With parens in the URL

+ +

(With outer parens and parens in url)

diff --git a/MarkdownTest/Tests/Links, inline style.text b/MarkdownTest/Tests/Links, inline style.text new file mode 100644 index 0000000..aba9658 --- /dev/null +++ b/MarkdownTest/Tests/Links, inline style.text @@ -0,0 +1,24 @@ +Just a [URL](/url/). + +[URL and title](/url/ "title"). + +[URL and title](/url/ "title preceded by two spaces"). + +[URL and title](/url/ "title preceded by a tab"). + +[URL and title](/url/ "title has spaces afterward" ). + +[URL wrapped in angle brackets](). + +[URL w/ angle brackets + title]( "Here's the title"). + +[Empty](). + +[With parens in the URL](http://en.wikipedia.org/wiki/WIMP_(computing)) + +(With outer parens and [parens in url](/foo(bar))) + + +[With parens in the URL](/foo(bar) "and a title") + +(With outer parens and [parens in url](/foo(bar) "and a title")) diff --git a/MarkdownTest/Tests/Links, reference style.html b/MarkdownTest/Tests/Links, reference style.html new file mode 100644 index 0000000..8e70c32 --- /dev/null +++ b/MarkdownTest/Tests/Links, reference style.html @@ -0,0 +1,52 @@ +

Foo bar.

+ +

Foo bar.

+ +

Foo bar.

+ +

With embedded [brackets].

+ +

Indented once.

+ +

Indented twice.

+ +

Indented thrice.

+ +

Indented [four][] times.

+ +
[four]: /url
+
+ +
+ +

this should work

+ +

So should this.

+ +

And this.

+ +

And this.

+ +

And this.

+ +

But not [that] [].

+ +

Nor [that][].

+ +

Nor [that].

+ +

[Something in brackets like this should work]

+ +

[Same with this.]

+ +

In this case, this points to something else.

+ +

Backslashing should suppress [this] and [this].

+ +
+ +

Here's one where the link +breaks across lines.

+ +

Here's another where the link +breaks across lines, but with a line-ending space.

diff --git a/MarkdownTest/Tests/Links, reference style.text b/MarkdownTest/Tests/Links, reference style.text new file mode 100644 index 0000000..341ec88 --- /dev/null +++ b/MarkdownTest/Tests/Links, reference style.text @@ -0,0 +1,71 @@ +Foo [bar] [1]. + +Foo [bar][1]. + +Foo [bar] +[1]. + +[1]: /url/ "Title" + + +With [embedded [brackets]] [b]. + + +Indented [once][]. + +Indented [twice][]. + +Indented [thrice][]. + +Indented [four][] times. + + [once]: /url + + [twice]: /url + + [thrice]: /url + + [four]: /url + + +[b]: /url/ + +* * * + +[this] [this] should work + +So should [this][this]. + +And [this] []. + +And [this][]. + +And [this]. + +But not [that] []. + +Nor [that][]. + +Nor [that]. + +[Something in brackets like [this][] should work] + +[Same with [this].] + +In this case, [this](/somethingelse/) points to something else. + +Backslashing should suppress \[this] and [this\]. + +[this]: foo + + +* * * + +Here's one where the [link +breaks] across lines. + +Here's another where the [link +breaks] across lines, but with a line-ending space. + + +[link breaks]: /url/ diff --git a/MarkdownTest/Tests/Links, shortcut references.html b/MarkdownTest/Tests/Links, shortcut references.html new file mode 100755 index 0000000..bf81e93 --- /dev/null +++ b/MarkdownTest/Tests/Links, shortcut references.html @@ -0,0 +1,9 @@ +

This is the simple case.

+ +

This one has a line +break.

+ +

This one has a line +break with a line-ending space.

+ +

this and the other

diff --git a/MarkdownTest/Tests/Links, shortcut references.text b/MarkdownTest/Tests/Links, shortcut references.text new file mode 100755 index 0000000..8c44c98 --- /dev/null +++ b/MarkdownTest/Tests/Links, shortcut references.text @@ -0,0 +1,20 @@ +This is the [simple case]. + +[simple case]: /simple + + + +This one has a [line +break]. + +This one has a [line +break] with a line-ending space. + +[line break]: /foo + + +[this] [that] and the [other] + +[this]: /this +[that]: /that +[other]: /other diff --git a/MarkdownTest/Tests/Literal quotes in titles.html b/MarkdownTest/Tests/Literal quotes in titles.html new file mode 100644 index 0000000..611c1ac --- /dev/null +++ b/MarkdownTest/Tests/Literal quotes in titles.html @@ -0,0 +1,3 @@ +

Foo bar.

+ +

Foo bar.

diff --git a/MarkdownTest/Tests/Literal quotes in titles.text b/MarkdownTest/Tests/Literal quotes in titles.text new file mode 100644 index 0000000..29d0e42 --- /dev/null +++ b/MarkdownTest/Tests/Literal quotes in titles.text @@ -0,0 +1,7 @@ +Foo [bar][]. + +Foo [bar](/url/ "Title with "quotes" inside"). + + + [bar]: /url/ "Title with "quotes" inside" + diff --git a/MarkdownTest/Tests/Markdown Documentation - Basics.html b/MarkdownTest/Tests/Markdown Documentation - Basics.html new file mode 100644 index 0000000..d5bdbb2 --- /dev/null +++ b/MarkdownTest/Tests/Markdown Documentation - Basics.html @@ -0,0 +1,314 @@ +

Markdown: Basics

+ + + +

Getting the Gist of Markdown's Formatting Syntax

+ +

This page offers a brief overview of what it's like to use Markdown. +The syntax page provides complete, detailed documentation for +every feature, but Markdown should be very easy to pick up simply by +looking at a few examples of it in action. The examples on this page +are written in a before/after style, showing example syntax and the +HTML output produced by Markdown.

+ +

It's also helpful to simply try Markdown out; the Dingus is a +web application that allows you type your own Markdown-formatted text +and translate it to XHTML.

+ +

Note: This document is itself written using Markdown; you +can see the source for it by adding '.text' to the URL.

+ +

Paragraphs, Headers, Blockquotes

+ +

A paragraph is simply one or more consecutive lines of text, separated +by one or more blank lines. (A blank line is any line that looks like a +blank line -- a line containing nothing spaces or tabs is considered +blank.) Normal paragraphs should not be intended with spaces or tabs.

+ +

Markdown offers two styles of headers: Setext and atx. +Setext-style headers for <h1> and <h2> are created by +"underlining" with equal signs (=) and hyphens (-), respectively. +To create an atx-style header, you put 1-6 hash marks (#) at the +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 Second Level Header
+---------------------
+
+Now is the time for all good men to come to
+the aid of their country. This is just a
+regular paragraph.
+
+The quick brown fox jumped over the lazy
+dog's back.
+
+### Header 3
+
+> This is a blockquote.
+> 
+> This is the second paragraph in the blockquote.
+>
+> ## This is an H2 in a blockquote
+
+ +

Output:

+ +
<h1>A First Level Header</h1>
+
+<h2>A Second Level Header</h2>
+
+<p>Now is the time for all good men to come to
+the aid of their country. This is just a
+regular paragraph.</p>
+
+<p>The quick brown fox jumped over the lazy
+dog's back.</p>
+
+<h3>Header 3</h3>
+
+<blockquote>
+    <p>This is a blockquote.</p>
+
+    <p>This is the second paragraph in the blockquote.</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 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>.
+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.
+*   Gum.
+*   Booze.
+
+ +

this:

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

and this:

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

all produce the same output:

+ +
<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
+2.  Green
+3.  Blue
+
+ +

Output:

+ +
<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.
+
+    With multiple paragraphs.
+
+*   Another item in the list.
+
+ +

Output:

+ +
<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/).
+
+ +

Output:

+ +
<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").
+
+ +

Output:

+ +
<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
+[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/"
+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
+[The New York Times][NY Times].
+
+[ny times]: http://www.nytimes.com/
+
+ +

Output:

+ +
<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")
+
+ +

Reference-style:

+ +
![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" />
+
+ +

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 wish SmartyPants used named entities like `&mdash;`
+instead of decimal-encoded entites like `&#8212;`.
+
+ +

Output:

+ +
<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,
+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,
+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>
+
diff --git a/MarkdownTest/Tests/Markdown Documentation - Basics.text b/MarkdownTest/Tests/Markdown Documentation - Basics.text new file mode 100644 index 0000000..486055c --- /dev/null +++ b/MarkdownTest/Tests/Markdown Documentation - Basics.text @@ -0,0 +1,306 @@ +Markdown: Basics +================ + + + + +Getting the Gist of Markdown's Formatting Syntax +------------------------------------------------ + +This page offers a brief overview of what it's like to use Markdown. +The [syntax page] [s] provides complete, detailed documentation for +every feature, but Markdown should be very easy to pick up simply by +looking at a few examples of it in action. The examples on this page +are written in a before/after style, showing example syntax and the +HTML output produced by Markdown. + +It's also helpful to simply try Markdown out; the [Dingus] [d] is a +web application that allows you type your own Markdown-formatted text +and translate it to XHTML. + +**Note:** This document is itself written using Markdown; you +can [see the source for it by adding '.text' to the URL] [src]. + + [s]: /projects/markdown/syntax "Markdown Syntax" + [d]: /projects/markdown/dingus "Markdown Dingus" + [src]: /projects/markdown/basics.text + + +## Paragraphs, Headers, Blockquotes ## + +A paragraph is simply one or more consecutive lines of text, separated +by one or more blank lines. (A blank line is any line that looks like a +blank line -- a line containing nothing spaces or tabs is considered +blank.) Normal paragraphs should not be intended with spaces or tabs. + +Markdown offers two styles of headers: *Setext* and *atx*. +Setext-style headers for `

` and `

` are created by +"underlining" with equal signs (`=`) and hyphens (`-`), respectively. +To create an atx-style header, you put 1-6 hash marks (`#`) at the +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 Second Level Header + --------------------- + + Now is the time for all good men to come to + the aid of their country. This is just a + regular paragraph. + + The quick brown fox jumped over the lazy + dog's back. + + ### Header 3 + + > This is a blockquote. + > + > This is the second paragraph in the blockquote. + > + > ## This is an H2 in a blockquote + + +Output: + +

A First Level Header

+ +

A Second Level Header

+ +

Now is the time for all good men to come to + the aid of their country. This is just a + regular paragraph.

+ +

The quick brown fox jumped over the lazy + dog's back.

+ +

Header 3

+ +
+

This is a blockquote.

+ +

This is the second paragraph in the blockquote.

+ +

This is an H2 in a 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 also_. + + Use two asterisks for **strong emphasis**. + Or, if you prefer, __use two underscores instead__. + +Output: + +

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.

+ + + +## Lists ## + +Unordered (bulleted) lists use asterisks, pluses, and hyphens (`*`, +`+`, and `-`) as list markers. These three markers are +interchangable; this: + + * Candy. + * Gum. + * Booze. + +this: + + + Candy. + + Gum. + + Booze. + +and this: + + - Candy. + - Gum. + - Booze. + +all produce the same output: + +
    +
  • Candy.
  • +
  • Gum.
  • +
  • Booze.
  • +
+ +Ordered (numbered) lists use regular numbers, followed by periods, as +list markers: + + 1. Red + 2. Green + 3. Blue + +Output: + +
    +
  1. Red
  2. +
  3. Green
  4. +
  5. Blue
  6. +
+ +If you put blank lines between items, you'll get `

` 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. + + With multiple paragraphs. + + * Another item in the list. + +Output: + +

    +
  • A list item.

    +

    With multiple paragraphs.

  • +
  • Another item in the list.

  • +
+ + + +### 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/). + +Output: + +

This is an + example link.

+ +Optionally, you may include a title attribute in the parentheses: + + This is an [example link](http://example.com/ "With a Title"). + +Output: + +

This is an + example link.

+ +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 + [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: + +

I get 10 times more traffic from Google than from Yahoo or MSN.

+ +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 + [The New York Times][NY Times]. + + [ny times]: http://www.nytimes.com/ + +Output: + +

I start my morning with a cup of coffee and + The New York Times.

+ + +### Images ### + +Image syntax is very much like link syntax. + +Inline (titles are optional): + + ![alt text](/path/to/img.jpg "Title") + +Reference-style: + + ![alt text][id] + + [id]: /path/to/img.jpg "Title" + +Both of the above examples produce the same output: + + alt text + + + +### 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 `` tags. + + I wish SmartyPants used named entities like `—` + instead of decimal-encoded entites like `—`. + +Output: + +

I strongly recommend against using any + <blink> tags.

+ +

I wish SmartyPants used named entities like + &mdash; instead of decimal-encoded + entites like &#8212;.

+ + +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, + you've got to put paragraph tags in your blockquotes: + +
+

For example.

+
+ +Output: + +

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>
+    
diff --git a/MarkdownTest/Tests/Markdown Documentation - Syntax.html b/MarkdownTest/Tests/Markdown Documentation - Syntax.html new file mode 100644 index 0000000..5c01306 --- /dev/null +++ b/MarkdownTest/Tests/Markdown Documentation - Syntax.html @@ -0,0 +1,942 @@ +

Markdown: Syntax

+ + + + + +

Note: This document is itself written using Markdown; you +can see the source for it by adding '.text' to the URL.

+ +
+ +

Overview

+ +

Philosophy

+ +

Markdown is intended to be as easy-to-read and easy-to-write as is feasible.

+ +

Readability, however, is emphasized above all else. A Markdown-formatted +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 Setext, atx, Textile, reStructuredText, +Grutatext, and EtText -- the single biggest source of +inspiration for Markdown's syntax is the format of plain text email.

+ +

To this end, Markdown's syntax is comprised entirely of punctuation +characters, which punctuation characters have been carefully chosen so +as to look like what they mean. E.g., asterisks around a word actually +look like *emphasis*. Markdown lists look like, well, lists. Even +blockquotes look like quoted passages of text, assuming you've ever +used email.

+ +

Inline HTML

+ +

Markdown's syntax is intended for one purpose: to be used as a +format for writing for the web.

+ +

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 not 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 publishing format; Markdown is a writing +format. Thus, Markdown's formatting syntax only addresses issues that +can be conveyed in plain text.

+ +

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 +indicate that you're switching from Markdown to HTML; you just use +the tags.

+ +

The only restrictions are that block-level HTML elements -- e.g. <div>, +<table>, <pre>, <p>, 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) <p> tags around HTML block-level tags.

+ +

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

+ +
This is a regular paragraph.
+
+<table>
+    <tr>
+        <td>Foo</td>
+    </tr>
+</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.

+ +

Span-level HTML tags -- e.g. <span>, <cite>, or <del> -- 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 <a> or <img> tags instead of Markdown's +link or image syntax, go right ahead.

+ +

Unlike block-level HTML tags, Markdown syntax is processed within +span-level tags.

+ +

Automatic Escaping for Special Characters

+ +

In HTML, there are two characters that demand special treatment: < +and &. Left angle brackets are used to start tags; ampersands are +used to denote HTML entities. If you want to use them as literal +characters, you must escape them as entities, e.g. &lt;, and +&amp;.

+ +

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
+
+ +

you need to encode the URL as:

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

+ +

Markdown allows you to use these characters naturally, taking care of +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;
+
+ +

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

+ +
AT&T
+
+ +

Markdown will translate it to:

+ +
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
+
+ +

Markdown will translate it to:

+ +
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 +terrible format for writing about HTML syntax, because every single < +and & in your example code needs to be escaped.)

+ +
+ +

Block Elements

+ +

Paragraphs and Line Breaks

+ +

A paragraph is simply one or more consecutive lines of text, separated +by one or more blank lines. (A blank line is any line that looks like a +blank line -- a line containing nothing but spaces or tabs is considered +blank.) Normal paragraphs should not be intended with spaces or tabs.

+ +

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 +character in a paragraph into a <br /> tag.

+ +

When you do want to insert a <br /> break tag using Markdown, you +end a line with two or more spaces, then type return.

+ +

Yes, this takes a tad more effort to create a <br />, but a simplistic +"every line break is a <br />" rule wouldn't work for Markdown. +Markdown's email-style blockquoting and multi-paragraph list items +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 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 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 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,
+> 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,
+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 nested blockquote.
+>
+> Back to the first level.
+
+ +

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

+ +
> ## This is a header.
+> 
+> 1.   This is the first list item.
+> 2.   This is the second list item.
+> 
+> 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.

+ +

Lists

+ +

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

+ +

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

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

is equivalent to:

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

and:

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

Ordered lists use numbers followed by periods:

+ +
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>
+<li>Bird</li>
+<li>McHale</li>
+<li>Parish</li>
+</ol>
+
+ +

If you instead wrote the list in Markdown like this:

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

or even:

+ +
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. +But if you want to be lazy, you don't have to.

+ +

If you do use lazy list numbering, however, you should still start the +list with the number 1. At some point in the future, Markdown may support +starting ordered lists at an arbitrary number.

+ +

List markers typically start at the left margin, but may be indented by +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.
+    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.
+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
+*   Magic
+
+ +

will turn into:

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

But this:

+ +
*   Bird
+
+*   Magic
+
+ +

will turn into:

+ +
<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
+    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.
+
+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 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:
+
+    > 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:
+
+        <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.
+
+ +

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

Code Blocks

+ +

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 <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 code block.
+
+ +

Markdown will generate:

+ +
<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:
+
+    tell application "Foo"
+        beep
+    end tell
+
+ +

will turn into:

+ +
<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 >) +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">
+        &copy; 2004 Foo Corporation
+    </div>
+
+ +

will turn into:

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

+ +

Horizontal Rules

+ +

You can produce a horizontal rule tag (<hr />) by placing three or +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:

+ +
* * *
+
+***
+
+*****
+
+- - -
+
+---------------------------------------
+
+_ _ _
+
+ +
+ +

Span Elements

+ + + +

Markdown supports two style of links: inline and reference.

+ +

In both styles, the link text is delimited by [square brackets].

+ +

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 optional +title for the link, surrounded in quotes. For example:

+ +
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">
+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.
+
+ +

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

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

+ +
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"
+
+ +

That is:

+ +
    +
  • Square brackets containing the link identifier (optionally +indented from the left margin using up to three spaces);
  • +
  • followed by a colon;
  • +
  • followed by one or more spaces (or tabs);
  • +
  • followed by the URL for the link;
  • +
  • optionally followed by a title attribute for the link, enclosed +in double or single quotes.
  • +
+ +

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

+ +
[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
+    "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]
+
+ +

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][]
+
+ +

And then define the link:

+ +
[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.
+
+ +

And then define the link:

+ +
[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
+[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
+[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/"
+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")
+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 +reference-style links, the paragraph itself is only 81 characters +long; with inline-style links, it's 176 characters; and as raw HTML, +it's 234 characters. In the raw HTML, there's more markup than there +is text.

+ +

With Markdown's reference-style links, a source document much more +closely resembles the final output, as rendered in a browser. By +allowing you to move the markup-related metadata out of the paragraph, +you can add links without interrupting the narrative flow of your +prose.

+ +

Emphasis

+ +

Markdown treats asterisks (*) and underscores (_) as indicators of +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 underscores_
+
+**double asterisks**
+
+__double underscores__
+
+ +

will produce:

+ +
<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
+
+ +

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\*
+
+ +

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

will produce:

+ +
<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.``
+
+ +

which will produce this:

+ +
<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 backtick-delimited string in a code span: `` `foo` ``
+
+ +

will produce:

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

into:

+ +
<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;`.
+
+ +

to produce:

+ +
<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 +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 "Optional title")
+
+ +

That is:

+ +
    +
  • An exclamation mark: !;
  • +
  • followed by a set of square brackets, containing the alt +attribute text for the image;
  • +
  • followed by a set of parentheses, containing the URL or path to +the image, and an optional title attribute enclosed in double +or single quotes.
  • +
+ +

Reference-style image syntax looks like this:

+ +
![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"
+
+ +

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.

+ +
+ +

Miscellaneous

+ + + +

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/>
+
+ +

Markdown will turn this into:

+ +
<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>
+
+ +

into something like this:

+ +
<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 +them. It's better than nothing, but an address published in this way +will probably eventually start receiving spam.)

+ +

Backslash Escapes

+ +

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 <em> tag), you can backslashes +before the asterisks, like this:

+ +
\*literal asterisks\*
+
+ +

Markdown provides backslash escapes for the following characters:

+ +
\   backslash
+`   backtick
+*   asterisk
+_   underscore
+{}  curly braces
+[]  square brackets
+()  parentheses
+#   hash mark
++   plus sign
+-   minus sign (hyphen)
+.   dot
+!   exclamation mark
+
diff --git a/MarkdownTest/Tests/Markdown Documentation - Syntax.text b/MarkdownTest/Tests/Markdown Documentation - Syntax.text new file mode 100644 index 0000000..57360a1 --- /dev/null +++ b/MarkdownTest/Tests/Markdown Documentation - Syntax.text @@ -0,0 +1,888 @@ +Markdown: Syntax +================ + + + + +* [Overview](#overview) + * [Philosophy](#philosophy) + * [Inline HTML](#html) + * [Automatic Escaping for Special Characters](#autoescape) +* [Block Elements](#block) + * [Paragraphs and Line Breaks](#p) + * [Headers](#header) + * [Blockquotes](#blockquote) + * [Lists](#list) + * [Code Blocks](#precode) + * [Horizontal Rules](#hr) +* [Span Elements](#span) + * [Links](#link) + * [Emphasis](#em) + * [Code](#code) + * [Images](#img) +* [Miscellaneous](#misc) + * [Backslash Escapes](#backslash) + * [Automatic Links](#autolink) + + +**Note:** This document is itself written using Markdown; you +can [see the source for it by adding '.text' to the URL][src]. + + [src]: /projects/markdown/syntax.text + +* * * + +

Overview

+ +

Philosophy

+ +Markdown is intended to be as easy-to-read and easy-to-write as is feasible. + +Readability, however, is emphasized above all else. A Markdown-formatted +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 [Setext] [1], [atx] [2], [Textile] [3], [reStructuredText] [4], +[Grutatext] [5], and [EtText] [6] -- the single biggest source of +inspiration for Markdown's syntax is the format of plain text email. + + [1]: http://docutils.sourceforge.net/mirror/setext.html + [2]: http://www.aaronsw.com/2002/atx/ + [3]: http://textism.com/tools/textile/ + [4]: http://docutils.sourceforge.net/rst.html + [5]: http://www.triptico.com/software/grutatxt.html + [6]: http://ettext.taint.org/doc/ + +To this end, Markdown's syntax is comprised entirely of punctuation +characters, which punctuation characters have been carefully chosen so +as to look like what they mean. E.g., asterisks around a word actually +look like \*emphasis\*. Markdown lists look like, well, lists. Even +blockquotes look like quoted passages of text, assuming you've ever +used email. + + + +

Inline HTML

+ +Markdown's syntax is intended for one purpose: to be used as a +format for *writing* for the web. + +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 *not* 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 *publishing* format; Markdown is a *writing* +format. Thus, Markdown's formatting syntax only addresses issues that +can be conveyed in plain text. + +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 +indicate that you're switching from Markdown to HTML; you just use +the tags. + +The only restrictions are that block-level HTML elements -- e.g. `
`, +``, `
`, `

`, 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) `

` tags around HTML block-level tags. + +For example, to add an HTML table to a Markdown article: + + This is a regular paragraph. + +

+ + + +
Foo
+ + 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. + +Span-level HTML tags -- e.g. ``, ``, or `` -- 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 `` or `` tags instead of Markdown's +link or image syntax, go right ahead. + +Unlike block-level HTML tags, Markdown syntax *is* processed within +span-level tags. + + +

Automatic Escaping for Special Characters

+ +In HTML, there are two characters that demand special treatment: `<` +and `&`. Left angle brackets are used to start tags; ampersands are +used to denote HTML entities. If you want to use them as literal +characters, you must escape them as entities, e.g. `<`, and +`&`. + +Ampersands in particular are bedeviling for web writers. If you want to +write about 'AT&T', you need to write '`AT&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 + +you need to encode the URL as: + + http://images.google.com/images?num=30&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. + +Markdown allows you to use these characters naturally, taking care of +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 `&`. + +So, if you want to include a copyright symbol in your article, you can write: + + © + +and Markdown will leave it alone. But if you write: + + AT&T + +Markdown will translate it to: + + AT&T + +Similarly, because Markdown supports [inline HTML](#html), if you use +angle brackets as delimiters for HTML tags, Markdown will treat them as +such. But if you write: + + 4 < 5 + +Markdown will translate it to: + + 4 < 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 +terrible format for writing about HTML syntax, because every single `<` +and `&` in your example code needs to be escaped.) + + +* * * + + +

Block Elements

+ + +

Paragraphs and Line Breaks

+ +A paragraph is simply one or more consecutive lines of text, separated +by one or more blank lines. (A blank line is any line that looks like a +blank line -- a line containing nothing but spaces or tabs is considered +blank.) Normal paragraphs should not be intended with spaces or tabs. + +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 +character in a paragraph into a `
` tag. + +When you *do* want to insert a `
` break tag using Markdown, you +end a line with two or more spaces, then type return. + +Yes, this takes a tad more effort to create a `
`, but a simplistic +"every line break is a `
`" rule wouldn't work for Markdown. +Markdown's email-style [blockquoting][bq] and multi-paragraph [list items][l] +work best -- and look better -- when you format them with hard breaks. + + [bq]: #blockquote + [l]: #list + + + + + +Markdown supports two styles of headers, [Setext] [1] and [atx] [2]. + +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 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 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 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, + > 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, + 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 nested blockquote. + > + > Back to the first level. + +Blockquotes can contain other Markdown elements, including headers, lists, +and code blocks: + + > ## This is a header. + > + > 1. This is the first list item. + > 2. This is the second list item. + > + > 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. + + +

Lists

+ +Markdown supports ordered (numbered) and unordered (bulleted) lists. + +Unordered lists use asterisks, pluses, and hyphens -- interchangably +-- as list markers: + + * Red + * Green + * Blue + +is equivalent to: + + + Red + + Green + + Blue + +and: + + - Red + - Green + - Blue + +Ordered lists use numbers followed by periods: + + 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: + +
    +
  1. Bird
  2. +
  3. McHale
  4. +
  5. Parish
  6. +
+ +If you instead wrote the list in Markdown like this: + + 1. Bird + 1. McHale + 1. Parish + +or even: + + 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. +But if you want to be lazy, you don't have to. + +If you do use lazy list numbering, however, you should still start the +list with the number 1. At some point in the future, Markdown may support +starting ordered lists at an arbitrary number. + +List markers typically start at the left margin, but may be indented by +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. + 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. + 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 `

` tags in the HTML output. For example, this input: + + * Bird + * Magic + +will turn into: + +

    +
  • Bird
  • +
  • Magic
  • +
+ +But this: + + * Bird + + * Magic + +will turn into: + +
    +
  • Bird

  • +
  • Magic

  • +
+ +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 + 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. + + 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 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: + + > 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: + + + + +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. + +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. + + + +

Code Blocks

+ +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 `
` and `` 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 code block.
+
+Markdown will generate:
+
+    

This is a normal paragraph:

+ +
This is a code block.
+    
+ +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: + + tell application "Foo" + beep + end tell + +will turn into: + +

Here is an example of AppleScript:

+ +
tell application "Foo"
+        beep
+    end tell
+    
+ +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 `>`) +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: + + + +will turn into: + +
<div class="footer">
+        &copy; 2004 Foo Corporation
+    </div>
+    
+ +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. + + + +

Horizontal Rules

+ +You can produce a horizontal rule tag (`
`) by placing three or +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: + + * * * + + *** + + ***** + + - - - + + --------------------------------------- + + _ _ _ + + +* * * + +

Span Elements

+ + + +Markdown supports two style of links: *inline* and *reference*. + +In both styles, the link text is delimited by [square brackets]. + +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 *optional* +title for the link, surrounded in quotes. For example: + + This is [an example](http://example.com/ "Title") inline link. + + [This link](http://example.net/) has no title attribute. + +Will produce: + +

This is + an example inline link.

+ +

This link has no + title attribute.

+ +If you're referring to a local resource on the same server, you can +use relative paths: + + 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. + +You can optionally use a space to separate the sets of brackets: + + 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" + +That is: + +* Square brackets containing the link identifier (optionally + indented from the left margin using up to three spaces); +* followed by a colon; +* followed by one or more spaces (or tabs); +* followed by the URL for the link; +* optionally followed by a title attribute for the link, enclosed + in double or single quotes. + +The link URL may, optionally, be surrounded by angle brackets: + + [id]: "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 + "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] + +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][] + +And then define the link: + + [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. + +And then define the link: + + [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 + [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 + [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: + +

I get 10 times more traffic from Google than from + Yahoo + or MSN.

+ +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") + 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 +reference-style links, the paragraph itself is only 81 characters +long; with inline-style links, it's 176 characters; and as raw HTML, +it's 234 characters. In the raw HTML, there's more markup than there +is text. + +With Markdown's reference-style links, a source document much more +closely resembles the final output, as rendered in a browser. By +allowing you to move the markup-related metadata out of the paragraph, +you can add links without interrupting the narrative flow of your +prose. + + +

Emphasis

+ +Markdown treats asterisks (`*`) and underscores (`_`) as indicators of +emphasis. Text wrapped with one `*` or `_` will be wrapped with an +HTML `` tag; double `*`'s or `_`'s will be wrapped with an HTML +`` tag. E.g., this input: + + *single asterisks* + + _single underscores_ + + **double asterisks** + + __double underscores__ + +will produce: + + single asterisks + + single underscores + + double asterisks + + double underscores + +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 + +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\* + + + +

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. + +will produce: + +

Use the printf() function.

+ +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.`` + +which will produce this: + +

There is a literal backtick (`) here.

+ +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 backtick-delimited string in a code span: `` `foo` `` + +will produce: + +

A single backtick in a code span: `

+ +

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

+ +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 `` tags. + +into: + +

Please don't use any <blink> tags.

+ +You can write this: + + `—` is the decimal-encoded equivalent of `—`. + +to produce: + +

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

+ + + +

Images

+ +Admittedly, it's fairly difficult to devise a "natural" syntax for +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 "Optional title") + +That is: + +* An exclamation mark: `!`; +* followed by a set of square brackets, containing the `alt` + attribute text for the image; +* followed by a set of parentheses, containing the URL or path to + the image, and an optional `title` attribute enclosed in double + or single quotes. + +Reference-style image syntax looks like this: + + ![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" + +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 `` tags. + + +* * * + + +

Miscellaneous

+ + + +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: + + + +Markdown will turn this into: + + http://example.com/ + +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: + + + +into something like this: + + address@exa + mple.com + +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 +them. It's better than nothing, but an address published in this way +will probably eventually start receiving spam.) + + + +

Backslash Escapes

+ +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 `` tag), you can backslashes +before the asterisks, like this: + + \*literal asterisks\* + +Markdown provides backslash escapes for the following characters: + + \ backslash + ` backtick + * asterisk + _ underscore + {} curly braces + [] square brackets + () parentheses + # hash mark + + plus sign + - minus sign (hyphen) + . dot + ! exclamation mark + diff --git a/MarkdownTest/Tests/Nested blockquotes.html b/MarkdownTest/Tests/Nested blockquotes.html new file mode 100644 index 0000000..d8ec7f8 --- /dev/null +++ b/MarkdownTest/Tests/Nested blockquotes.html @@ -0,0 +1,9 @@ +
+

foo

+ +
+

bar

+
+ +

foo

+
diff --git a/MarkdownTest/Tests/Nested blockquotes.text b/MarkdownTest/Tests/Nested blockquotes.text new file mode 100644 index 0000000..ed3c624 --- /dev/null +++ b/MarkdownTest/Tests/Nested blockquotes.text @@ -0,0 +1,5 @@ +> foo +> +> > bar +> +> foo diff --git a/MarkdownTest/Tests/Ordered and unordered lists.html b/MarkdownTest/Tests/Ordered and unordered lists.html new file mode 100644 index 0000000..ba71eab --- /dev/null +++ b/MarkdownTest/Tests/Ordered and unordered lists.html @@ -0,0 +1,148 @@ +

Unordered

+ +

Asterisks tight:

+ +
    +
  • asterisk 1
  • +
  • asterisk 2
  • +
  • asterisk 3
  • +
+ +

Asterisks loose:

+ +
    +
  • asterisk 1

  • +
  • asterisk 2

  • +
  • asterisk 3

  • +
+ +
+ +

Pluses tight:

+ +
    +
  • Plus 1
  • +
  • Plus 2
  • +
  • Plus 3
  • +
+ +

Pluses loose:

+ +
    +
  • Plus 1

  • +
  • Plus 2

  • +
  • Plus 3

  • +
+ +
+ +

Minuses tight:

+ +
    +
  • Minus 1
  • +
  • Minus 2
  • +
  • Minus 3
  • +
+ +

Minuses loose:

+ +
    +
  • Minus 1

  • +
  • Minus 2

  • +
  • Minus 3

  • +
+ +

Ordered

+ +

Tight:

+ +
    +
  1. First
  2. +
  3. Second
  4. +
  5. Third
  6. +
+ +

and:

+ +
    +
  1. One
  2. +
  3. Two
  4. +
  5. Three
  6. +
+ +

Loose using tabs:

+ +
    +
  1. First

  2. +
  3. Second

  4. +
  5. Third

  6. +
+ +

and using spaces:

+ +
    +
  1. One

  2. +
  3. Two

  4. +
  5. Three

  6. +
+ +

Multiple paragraphs:

+ +
    +
  1. Item 1, graf one.

    + +

    Item 2. graf two. The quick brown fox jumped over the lazy dog's +back.

  2. +
  3. Item 2.

  4. +
  5. Item 3.

  6. +
+ +

Nested

+ +
    +
  • Tab +
      +
    • Tab +
        +
      • Tab
      • +
    • +
  • +
+ +

Here's another:

+ +
    +
  1. First
  2. +
  3. Second: +
      +
    • Fee
    • +
    • Fie
    • +
    • Foe
    • +
  4. +
  5. Third
  6. +
+ +

Same thing but with paragraphs:

+ +
    +
  1. First

  2. +
  3. Second:

    + +
      +
    • Fee
    • +
    • Fie
    • +
    • Foe
    • +
  4. +
  5. Third

  6. +
+ + +

This was an error in Markdown 1.0.1:

+ +
    +
  • this

    + +
    • sub
    + +

    that

  • +
diff --git a/MarkdownTest/Tests/Ordered and unordered lists.text b/MarkdownTest/Tests/Ordered and unordered lists.text new file mode 100644 index 0000000..7f3b497 --- /dev/null +++ b/MarkdownTest/Tests/Ordered and unordered lists.text @@ -0,0 +1,131 @@ +## Unordered + +Asterisks tight: + +* asterisk 1 +* asterisk 2 +* asterisk 3 + + +Asterisks loose: + +* asterisk 1 + +* asterisk 2 + +* asterisk 3 + +* * * + +Pluses tight: + ++ Plus 1 ++ Plus 2 ++ Plus 3 + + +Pluses loose: + ++ Plus 1 + ++ Plus 2 + ++ Plus 3 + +* * * + + +Minuses tight: + +- Minus 1 +- Minus 2 +- Minus 3 + + +Minuses loose: + +- Minus 1 + +- Minus 2 + +- Minus 3 + + +## Ordered + +Tight: + +1. First +2. Second +3. Third + +and: + +1. One +2. Two +3. Three + + +Loose using tabs: + +1. First + +2. Second + +3. Third + +and using spaces: + +1. One + +2. Two + +3. Three + +Multiple paragraphs: + +1. Item 1, graf one. + + Item 2. graf two. The quick brown fox jumped over the lazy dog's + back. + +2. Item 2. + +3. Item 3. + + + +## Nested + +* Tab + * Tab + * Tab + +Here's another: + +1. First +2. Second: + * Fee + * Fie + * Foe +3. Third + +Same thing but with paragraphs: + +1. First + +2. Second: + * Fee + * Fie + * Foe + +3. Third + + +This was an error in Markdown 1.0.1: + +* this + + * sub + + that diff --git a/MarkdownTest/Tests/Strong and em together.html b/MarkdownTest/Tests/Strong and em together.html new file mode 100644 index 0000000..71ec78c --- /dev/null +++ b/MarkdownTest/Tests/Strong and em together.html @@ -0,0 +1,7 @@ +

This is strong and em.

+ +

So is this word.

+ +

This is strong and em.

+ +

So is this word.

diff --git a/MarkdownTest/Tests/Strong and em together.text b/MarkdownTest/Tests/Strong and em together.text new file mode 100644 index 0000000..95ee690 --- /dev/null +++ b/MarkdownTest/Tests/Strong and em together.text @@ -0,0 +1,7 @@ +***This is strong and em.*** + +So is ***this*** word. + +___This is strong and em.___ + +So is ___this___ word. diff --git a/MarkdownTest/Tests/Tabs.html b/MarkdownTest/Tests/Tabs.html new file mode 100644 index 0000000..3301ba8 --- /dev/null +++ b/MarkdownTest/Tests/Tabs.html @@ -0,0 +1,25 @@ +
    +
  • this is a list item +indented with tabs

  • +
  • this is a list item +indented with spaces

  • +
+ +

Code:

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

And:

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

And:

+ +
+   this is an example list item
+    indented with tabs
+
++   this is an example list item
+    indented with spaces
+
diff --git a/MarkdownTest/Tests/Tabs.text b/MarkdownTest/Tests/Tabs.text new file mode 100644 index 0000000..589d113 --- /dev/null +++ b/MarkdownTest/Tests/Tabs.text @@ -0,0 +1,21 @@ ++ this is a list item + indented with tabs + ++ this is a list item + indented with spaces + +Code: + + this code block is indented by one tab + +And: + + this code block is indented by two tabs + +And: + + + this is an example list item + indented with tabs + + + this is an example list item + indented with spaces diff --git a/MarkdownTest/Tests/Tidyness.html b/MarkdownTest/Tests/Tidyness.html new file mode 100644 index 0000000..f2a8ce7 --- /dev/null +++ b/MarkdownTest/Tests/Tidyness.html @@ -0,0 +1,8 @@ +
+

A list within a blockquote:

+
    +
  • asterisk 1
  • +
  • asterisk 2
  • +
  • asterisk 3
  • +
+
diff --git a/MarkdownTest/Tests/Tidyness.text b/MarkdownTest/Tests/Tidyness.text new file mode 100644 index 0000000..5f18b8d --- /dev/null +++ b/MarkdownTest/Tests/Tidyness.text @@ -0,0 +1,5 @@ +> A list within a blockquote: +> +> * asterisk 1 +> * asterisk 2 +> * asterisk 3 diff --git a/MarkdownTest/Tests_2004/Amps and angle encoding.html b/MarkdownTest/Tests_2004/Amps and angle encoding.html new file mode 100644 index 0000000..9606860 --- /dev/null +++ b/MarkdownTest/Tests_2004/Amps and angle encoding.html @@ -0,0 +1,17 @@ +

AT&T has an ampersand in their name.

+ +

AT&T is another way to write it.

+ +

This & that.

+ +

4 < 5.

+ +

6 > 5.

+ +

Here's a link with an ampersand in the URL.

+ +

Here's a link with an amersand in the link text: AT&T.

+ +

Here's an inline link.

+ +

Here's an inline link.

diff --git a/MarkdownTest/Tests_2004/Amps and angle encoding.text b/MarkdownTest/Tests_2004/Amps and angle encoding.text new file mode 100644 index 0000000..0e9527f --- /dev/null +++ b/MarkdownTest/Tests_2004/Amps and angle encoding.text @@ -0,0 +1,21 @@ +AT&T has an ampersand in their name. + +AT&T is another way to write it. + +This & that. + +4 < 5. + +6 > 5. + +Here's a [link] [1] with an ampersand in the URL. + +Here's a link with an amersand in the link text: [AT&T] [2]. + +Here's an inline [link](/script?foo=1&bar=2). + +Here's an inline [link](). + + +[1]: http://example.com/?foo=1&bar=2 +[2]: http://att.com/ "AT&T" \ No newline at end of file diff --git a/MarkdownTest/Tests_2004/Amps and angle encoding.text-out b/MarkdownTest/Tests_2004/Amps and angle encoding.text-out new file mode 100644 index 0000000..d52a97e --- /dev/null +++ b/MarkdownTest/Tests_2004/Amps and angle encoding.text-out @@ -0,0 +1,21 @@ + + + + + + + +

AT&T has an ampersand in their name.

+

AT&T is another way to write it.

+

This & that.

+

4 < 5.

+

6 > 5.

+

Here's a link +with an ampersand in the URL.

+

Here's a link with an amersand in the link text: AT&T.

+

Here's an inline link.

+

Here's an inline link.

+ + diff --git a/MarkdownTest/Tests_2004/Amps and angle encoding.text-res b/MarkdownTest/Tests_2004/Amps and angle encoding.text-res new file mode 100644 index 0000000..d52a97e --- /dev/null +++ b/MarkdownTest/Tests_2004/Amps and angle encoding.text-res @@ -0,0 +1,21 @@ + + + + + + + +

AT&T has an ampersand in their name.

+

AT&T is another way to write it.

+

This & that.

+

4 < 5.

+

6 > 5.

+

Here's a link +with an ampersand in the URL.

+

Here's a link with an amersand in the link text: AT&T.

+

Here's an inline link.

+

Here's an inline link.

+ + diff --git a/MarkdownTest/Tests_2004/Auto links.html b/MarkdownTest/Tests_2004/Auto links.html new file mode 100644 index 0000000..f8df985 --- /dev/null +++ b/MarkdownTest/Tests_2004/Auto links.html @@ -0,0 +1,18 @@ +

Link: http://example.com/.

+ +

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

+ + + +
+

Blockquoted: http://example.com/

+
+ +

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

+ +
or here: <http://example.com/>
+
diff --git a/MarkdownTest/Tests_2004/Auto links.text b/MarkdownTest/Tests_2004/Auto links.text new file mode 100644 index 0000000..abbc488 --- /dev/null +++ b/MarkdownTest/Tests_2004/Auto links.text @@ -0,0 +1,13 @@ +Link: . + +With an ampersand: + +* In a list? +* +* It should. + +> Blockquoted: + +Auto-links should not occur here: `` + + or here: \ No newline at end of file diff --git a/MarkdownTest/Tests_2004/Auto links.text-out b/MarkdownTest/Tests_2004/Auto links.text-out new file mode 100644 index 0000000..3b20890 --- /dev/null +++ b/MarkdownTest/Tests_2004/Auto links.text-out @@ -0,0 +1,28 @@ + + + + + + + +

Link: http://example.com/.

+

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

+ +
+

Blockquoted: http://example.com/

+
+

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

+
+or here: <http://example.com/>
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Auto links.text-res b/MarkdownTest/Tests_2004/Auto links.text-res new file mode 100644 index 0000000..3b20890 --- /dev/null +++ b/MarkdownTest/Tests_2004/Auto links.text-res @@ -0,0 +1,28 @@ + + + + + + + +

Link: http://example.com/.

+

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

+ +
+

Blockquoted: http://example.com/

+
+

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

+
+or here: <http://example.com/>
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Backslash escapes.html b/MarkdownTest/Tests_2004/Backslash escapes.html new file mode 100644 index 0000000..77823c3 --- /dev/null +++ b/MarkdownTest/Tests_2004/Backslash escapes.html @@ -0,0 +1,102 @@ +

These should all get escaped:

+ +

Backslash: \

+ +

Backtick: `

+ +

Asterisk: *

+ +

Underscore: _

+ +

Left brace: {

+ +

Right brace: }

+ +

Left bracket: [

+ +

Right bracket: ]

+ +

Left paren: (

+ +

Right paren: )

+ +

Greater-than: >

+ +

Hash: #

+ +

Period: .

+ +

Bang: !

+ +

Plus: +

+ +

Minus: -

+ +

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

+ +
Backslash: \\
+
+Backtick: \`
+
+Asterisk: \*
+
+Underscore: \_
+
+Left brace: \{
+
+Right brace: \}
+
+Left bracket: \[
+
+Right bracket: \]
+
+Left paren: \(
+
+Right paren: \)
+
+Greater-than: \>
+
+Hash: \#
+
+Period: \.
+
+Bang: \!
+
+Plus: \+
+
+Minus: \-
+
+ +

Nor should these, which occur in code spans:

+ +

Backslash: \\

+ +

Backtick: \`

+ +

Asterisk: \*

+ +

Underscore: \_

+ +

Left brace: \{

+ +

Right brace: \}

+ +

Left bracket: \[

+ +

Right bracket: \]

+ +

Left paren: \(

+ +

Right paren: \)

+ +

Greater-than: \>

+ +

Hash: \#

+ +

Period: \.

+ +

Bang: \!

+ +

Plus: \+

+ +

Minus: \-

diff --git a/MarkdownTest/Tests_2004/Backslash escapes.text b/MarkdownTest/Tests_2004/Backslash escapes.text new file mode 100644 index 0000000..16447a0 --- /dev/null +++ b/MarkdownTest/Tests_2004/Backslash escapes.text @@ -0,0 +1,104 @@ +These should all get escaped: + +Backslash: \\ + +Backtick: \` + +Asterisk: \* + +Underscore: \_ + +Left brace: \{ + +Right brace: \} + +Left bracket: \[ + +Right bracket: \] + +Left paren: \( + +Right paren: \) + +Greater-than: \> + +Hash: \# + +Period: \. + +Bang: \! + +Plus: \+ + +Minus: \- + + + +These should not, because they occur within a code block: + + Backslash: \\ + + Backtick: \` + + Asterisk: \* + + Underscore: \_ + + Left brace: \{ + + Right brace: \} + + Left bracket: \[ + + Right bracket: \] + + Left paren: \( + + Right paren: \) + + Greater-than: \> + + Hash: \# + + Period: \. + + Bang: \! + + Plus: \+ + + Minus: \- + + +Nor should these, which occur in code spans: + +Backslash: `\\` + +Backtick: `` \` `` + +Asterisk: `\*` + +Underscore: `\_` + +Left brace: `\{` + +Right brace: `\}` + +Left bracket: `\[` + +Right bracket: `\]` + +Left paren: `\(` + +Right paren: `\)` + +Greater-than: `\>` + +Hash: `\#` + +Period: `\.` + +Bang: `\!` + +Plus: `\+` + +Minus: `\-` diff --git a/MarkdownTest/Tests_2004/Backslash escapes.text-out b/MarkdownTest/Tests_2004/Backslash escapes.text-out new file mode 100644 index 0000000..1aae6cc --- /dev/null +++ b/MarkdownTest/Tests_2004/Backslash escapes.text-out @@ -0,0 +1,79 @@ + + + + + + + +

These should all get escaped:

+

Backslash: \

+

Backtick: `

+

Asterisk: *

+

Underscore: _

+

Left brace: {

+

Right brace: }

+

Left bracket: [

+

Right bracket: ]

+

Left paren: (

+

Right paren: )

+

Greater-than: >

+

Hash: #

+

Period: .

+

Bang: !

+

Plus: +

+

Minus: -

+

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

+
+Backslash: \
+
+Backtick: \`
+
+Asterisk: \*
+
+Underscore: \_
+
+Left brace: \{
+
+Right brace: \}
+
+Left bracket: \[
+
+Right bracket: \]
+
+Left paren: \(
+
+Right paren: \)
+
+Greater-than: \>
+
+Hash: \#
+
+Period: \.
+
+Bang: \!
+
+Plus: \+
+
+Minus: \-
+
+
+

Nor should these, which occur in code spans:

+

Backslash: \

+

Backtick: \`

+

Asterisk: \*

+

Underscore: \_

+

Left brace: \{

+

Right brace: \}

+

Left bracket: \[

+

Right bracket: \]

+

Left paren: \(

+

Right paren: \)

+

Greater-than: \>

+

Hash: \#

+

Period: \.

+

Bang: \!

+

Plus: \+

+

Minus: \-

+ + diff --git a/MarkdownTest/Tests_2004/Backslash escapes.text-res b/MarkdownTest/Tests_2004/Backslash escapes.text-res new file mode 100644 index 0000000..1aae6cc --- /dev/null +++ b/MarkdownTest/Tests_2004/Backslash escapes.text-res @@ -0,0 +1,79 @@ + + + + + + + +

These should all get escaped:

+

Backslash: \

+

Backtick: `

+

Asterisk: *

+

Underscore: _

+

Left brace: {

+

Right brace: }

+

Left bracket: [

+

Right bracket: ]

+

Left paren: (

+

Right paren: )

+

Greater-than: >

+

Hash: #

+

Period: .

+

Bang: !

+

Plus: +

+

Minus: -

+

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

+
+Backslash: \
+
+Backtick: \`
+
+Asterisk: \*
+
+Underscore: \_
+
+Left brace: \{
+
+Right brace: \}
+
+Left bracket: \[
+
+Right bracket: \]
+
+Left paren: \(
+
+Right paren: \)
+
+Greater-than: \>
+
+Hash: \#
+
+Period: \.
+
+Bang: \!
+
+Plus: \+
+
+Minus: \-
+
+
+

Nor should these, which occur in code spans:

+

Backslash: \

+

Backtick: \`

+

Asterisk: \*

+

Underscore: \_

+

Left brace: \{

+

Right brace: \}

+

Left bracket: \[

+

Right bracket: \]

+

Left paren: \(

+

Right paren: \)

+

Greater-than: \>

+

Hash: \#

+

Period: \.

+

Bang: \!

+

Plus: \+

+

Minus: \-

+ + diff --git a/MarkdownTest/Tests_2004/Blockquotes with code blocks.html b/MarkdownTest/Tests_2004/Blockquotes with code blocks.html new file mode 100644 index 0000000..990202a --- /dev/null +++ b/MarkdownTest/Tests_2004/Blockquotes with code blocks.html @@ -0,0 +1,15 @@ +
+

Example:

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

Or:

+ +
sub status {
+    return "working";
+}
+
+
diff --git a/MarkdownTest/Tests_2004/Blockquotes with code blocks.text b/MarkdownTest/Tests_2004/Blockquotes with code blocks.text new file mode 100644 index 0000000..c31d171 --- /dev/null +++ b/MarkdownTest/Tests_2004/Blockquotes with code blocks.text @@ -0,0 +1,11 @@ +> Example: +> +> sub status { +> print "working"; +> } +> +> Or: +> +> sub status { +> return "working"; +> } diff --git a/MarkdownTest/Tests_2004/Blockquotes with code blocks.text-out b/MarkdownTest/Tests_2004/Blockquotes with code blocks.text-out new file mode 100644 index 0000000..75ef055 --- /dev/null +++ b/MarkdownTest/Tests_2004/Blockquotes with code blocks.text-out @@ -0,0 +1,25 @@ + + + + + + + +
+

Example:

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

Or:

+
+sub status {
+    return "working";
+}
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Blockquotes with code blocks.text-res b/MarkdownTest/Tests_2004/Blockquotes with code blocks.text-res new file mode 100644 index 0000000..75ef055 --- /dev/null +++ b/MarkdownTest/Tests_2004/Blockquotes with code blocks.text-res @@ -0,0 +1,25 @@ + + + + + + + +
+

Example:

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

Or:

+
+sub status {
+    return "working";
+}
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.html b/MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.html new file mode 100644 index 0000000..e21ac79 --- /dev/null +++ b/MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.html @@ -0,0 +1,8 @@ +

In Markdown 1.0.0 and earlier. Version +8. This line turns into a list item. +Because a hard-wrapped line in the +middle of a paragraph looked like a +list item.

+ +

Here's one with a bullet. +* criminey.

diff --git a/MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.text b/MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.text new file mode 100644 index 0000000..f8a5b27 --- /dev/null +++ b/MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.text @@ -0,0 +1,8 @@ +In Markdown 1.0.0 and earlier. Version +8. This line turns into a list item. +Because a hard-wrapped line in the +middle of a paragraph looked like a +list item. + +Here's one with a bullet. +* criminey. diff --git a/MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.text-out b/MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.text-out new file mode 100644 index 0000000..e044b46 --- /dev/null +++ b/MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.text-out @@ -0,0 +1,14 @@ + + + + + + + +

In Markdown 1.0.0 and earlier. Version 8. This line turns into a +list item. Because a hard-wrapped line in the middle of a paragraph +looked like a list item.

+

Here's one with a bullet. * criminey.

+ + diff --git a/MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.text-res b/MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.text-res new file mode 100644 index 0000000..e044b46 --- /dev/null +++ b/MarkdownTest/Tests_2004/Hard-wrapped paragraphs with list-like lines.text-res @@ -0,0 +1,14 @@ + + + + + + + +

In Markdown 1.0.0 and earlier. Version 8. This line turns into a +list item. Because a hard-wrapped line in the middle of a paragraph +looked like a list item.

+

Here's one with a bullet. * criminey.

+ + diff --git a/MarkdownTest/Tests_2004/Horizontal rules.html b/MarkdownTest/Tests_2004/Horizontal rules.html new file mode 100644 index 0000000..2dc2ab6 --- /dev/null +++ b/MarkdownTest/Tests_2004/Horizontal rules.html @@ -0,0 +1,71 @@ +

Dashes:

+ +
+ +
+ +
+ +
+ +
---
+
+ +
+ +
+ +
+ +
+ +
- - -
+
+ +

Asterisks:

+ +
+ +
+ +
+ +
+ +
***
+
+ +
+ +
+ +
+ +
+ +
* * *
+
+ +

Underscores:

+ +
+ +
+ +
+ +
+ +
___
+
+ +
+ +
+ +
+ +
+ +
_ _ _
+
diff --git a/MarkdownTest/Tests_2004/Horizontal rules.text b/MarkdownTest/Tests_2004/Horizontal rules.text new file mode 100644 index 0000000..1594bda --- /dev/null +++ b/MarkdownTest/Tests_2004/Horizontal rules.text @@ -0,0 +1,67 @@ +Dashes: + +--- + + --- + + --- + + --- + + --- + +- - - + + - - - + + - - - + + - - - + + - - - + + +Asterisks: + +*** + + *** + + *** + + *** + + *** + +* * * + + * * * + + * * * + + * * * + + * * * + + +Underscores: + +___ + + ___ + + ___ + + ___ + + ___ + +_ _ _ + + _ _ _ + + _ _ _ + + _ _ _ + + _ _ _ diff --git a/MarkdownTest/Tests_2004/Horizontal rules.text-out b/MarkdownTest/Tests_2004/Horizontal rules.text-out new file mode 100644 index 0000000..71e4d27 --- /dev/null +++ b/MarkdownTest/Tests_2004/Horizontal rules.text-out @@ -0,0 +1,61 @@ + + + + + + + +

Dashes:

+
+
+
+
+
+---
+
+
+
+
+
+
+
+- - -
+
+
+

Asterisks:

+
+
+
+
+
+***
+
+
+
+
+
+
+
+* * *
+
+
+

Underscores:

+
+
+
+
+
+___
+
+
+
+
+
+
+
+_ _ _
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Horizontal rules.text-res b/MarkdownTest/Tests_2004/Horizontal rules.text-res new file mode 100644 index 0000000..71e4d27 --- /dev/null +++ b/MarkdownTest/Tests_2004/Horizontal rules.text-res @@ -0,0 +1,61 @@ + + + + + + + +

Dashes:

+
+
+
+
+
+---
+
+
+
+
+
+
+
+- - -
+
+
+

Asterisks:

+
+
+
+
+
+***
+
+
+
+
+
+
+
+* * *
+
+
+

Underscores:

+
+
+
+
+
+___
+
+
+
+
+
+
+
+_ _ _
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Inline HTML (Advanced).html b/MarkdownTest/Tests_2004/Inline HTML (Advanced).html new file mode 100644 index 0000000..1972d87 --- /dev/null +++ b/MarkdownTest/Tests_2004/Inline HTML (Advanced).html @@ -0,0 +1,14 @@ +

Simple block on one line:

+ +
foo
+ +

And nested without indentation:

+ +
+
+
+foo +
+
+
bar
+
diff --git a/MarkdownTest/Tests_2004/Inline HTML (Advanced).text b/MarkdownTest/Tests_2004/Inline HTML (Advanced).text new file mode 100644 index 0000000..9d71ddc --- /dev/null +++ b/MarkdownTest/Tests_2004/Inline HTML (Advanced).text @@ -0,0 +1,14 @@ +Simple block on one line: + +
foo
+ +And nested without indentation: + +
+
+
+foo +
+
+
bar
+
diff --git a/MarkdownTest/Tests_2004/Inline HTML (Advanced).text-out b/MarkdownTest/Tests_2004/Inline HTML (Advanced).text-out new file mode 100644 index 0000000..ee84e31 --- /dev/null +++ b/MarkdownTest/Tests_2004/Inline HTML (Advanced).text-out @@ -0,0 +1,19 @@ + + + + + + + +

Simple block on one line:

+
foo
+

And nested without indentation:

+
+
+
foo
+
+
bar
+
+ + diff --git a/MarkdownTest/Tests_2004/Inline HTML (Advanced).text-res b/MarkdownTest/Tests_2004/Inline HTML (Advanced).text-res new file mode 100644 index 0000000..ee84e31 --- /dev/null +++ b/MarkdownTest/Tests_2004/Inline HTML (Advanced).text-res @@ -0,0 +1,19 @@ + + + + + + + +

Simple block on one line:

+
foo
+

And nested without indentation:

+
+
+
foo
+
+
bar
+
+ + diff --git a/MarkdownTest/Tests_2004/Inline HTML (Simple).html b/MarkdownTest/Tests_2004/Inline HTML (Simple).html new file mode 100644 index 0000000..6bf78f8 --- /dev/null +++ b/MarkdownTest/Tests_2004/Inline HTML (Simple).html @@ -0,0 +1,72 @@ +

Here's a simple block:

+ +
+ foo +
+ +

This should be a code block, though:

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

As should this:

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

Now, nested:

+ +
+
+
+ foo +
+
+
+ +

This should just be an HTML comment:

+ + + +

Multiline:

+ + + +

Code block:

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

Just plain comment, with trailing spaces on the line:

+ + + +

Code:

+ +
<hr />
+
+ +

Hr's:

+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
diff --git a/MarkdownTest/Tests_2004/Inline HTML (Simple).text b/MarkdownTest/Tests_2004/Inline HTML (Simple).text new file mode 100644 index 0000000..14aa2dc --- /dev/null +++ b/MarkdownTest/Tests_2004/Inline HTML (Simple).text @@ -0,0 +1,69 @@ +Here's a simple block: + +
+ foo +
+ +This should be a code block, though: + +
+ foo +
+ +As should this: + +
foo
+ +Now, nested: + +
+
+
+ foo +
+
+
+ +This should just be an HTML comment: + + + +Multiline: + + + +Code block: + + + +Just plain comment, with trailing spaces on the line: + + + +Code: + +
+ +Hr's: + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ diff --git a/MarkdownTest/Tests_2004/Inline HTML (Simple).text-out b/MarkdownTest/Tests_2004/Inline HTML (Simple).text-out new file mode 100644 index 0000000..a5022e0 --- /dev/null +++ b/MarkdownTest/Tests_2004/Inline HTML (Simple).text-out @@ -0,0 +1,59 @@ + + + + + + + +

Here's a simple block:

+
foo
+

This should be a code block, though:

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

As should this:

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

Now, nested:

+
+
+
foo
+
+
+

This should just be an HTML comment:

+ +

Multiline:

+ +

Code block:

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

Just plain comment, with trailing spaces on the line:

+ +

Code:

+
+<hr />
+
+
+

Hr's:

+
+
+
+
+
+
+
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Inline HTML (Simple).text-res b/MarkdownTest/Tests_2004/Inline HTML (Simple).text-res new file mode 100644 index 0000000..a5022e0 --- /dev/null +++ b/MarkdownTest/Tests_2004/Inline HTML (Simple).text-res @@ -0,0 +1,59 @@ + + + + + + + +

Here's a simple block:

+
foo
+

This should be a code block, though:

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

As should this:

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

Now, nested:

+
+
+
foo
+
+
+

This should just be an HTML comment:

+ +

Multiline:

+ +

Code block:

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

Just plain comment, with trailing spaces on the line:

+ +

Code:

+
+<hr />
+
+
+

Hr's:

+
+
+
+
+
+
+
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Inline HTML comments.html b/MarkdownTest/Tests_2004/Inline HTML comments.html new file mode 100644 index 0000000..3f167a1 --- /dev/null +++ b/MarkdownTest/Tests_2004/Inline HTML comments.html @@ -0,0 +1,13 @@ +

Paragraph one.

+ + + + + +

Paragraph two.

+ + + +

The end.

diff --git a/MarkdownTest/Tests_2004/Inline HTML comments.text b/MarkdownTest/Tests_2004/Inline HTML comments.text new file mode 100644 index 0000000..41d830d --- /dev/null +++ b/MarkdownTest/Tests_2004/Inline HTML comments.text @@ -0,0 +1,13 @@ +Paragraph one. + + + + + +Paragraph two. + + + +The end. diff --git a/MarkdownTest/Tests_2004/Inline HTML comments.text-out b/MarkdownTest/Tests_2004/Inline HTML comments.text-out new file mode 100644 index 0000000..6e2f425 --- /dev/null +++ b/MarkdownTest/Tests_2004/Inline HTML comments.text-out @@ -0,0 +1,18 @@ + + + + + + + +

Paragraph one.

+ + +

Paragraph two.

+ +

The end.

+ + diff --git a/MarkdownTest/Tests_2004/Inline HTML comments.text-res b/MarkdownTest/Tests_2004/Inline HTML comments.text-res new file mode 100644 index 0000000..6e2f425 --- /dev/null +++ b/MarkdownTest/Tests_2004/Inline HTML comments.text-res @@ -0,0 +1,18 @@ + + + + + + + +

Paragraph one.

+ + +

Paragraph two.

+ +

The end.

+ + diff --git a/MarkdownTest/Tests_2004/Links, inline style.html b/MarkdownTest/Tests_2004/Links, inline style.html new file mode 100644 index 0000000..bdfabb5 --- /dev/null +++ b/MarkdownTest/Tests_2004/Links, inline style.html @@ -0,0 +1,9 @@ +

Just a URL.

+ +

URL and title.

+ +

URL and title.

+ +

URL and title.

+ +

Empty.

diff --git a/MarkdownTest/Tests_2004/Links, inline style.text b/MarkdownTest/Tests_2004/Links, inline style.text new file mode 100644 index 0000000..4d0c1c2 --- /dev/null +++ b/MarkdownTest/Tests_2004/Links, inline style.text @@ -0,0 +1,9 @@ +Just a [URL](/url/). + +[URL and title](/url/ "title"). + +[URL and title](/url/ "title preceded by two spaces"). + +[URL and title](/url/ "title preceded by a tab"). + +[Empty](). diff --git a/MarkdownTest/Tests_2004/Links, inline style.text-out b/MarkdownTest/Tests_2004/Links, inline style.text-out new file mode 100644 index 0000000..0125b63 --- /dev/null +++ b/MarkdownTest/Tests_2004/Links, inline style.text-out @@ -0,0 +1,17 @@ + + + + + + + +

Just a URL.

+

URL and title.

+

URL and +title.

+

URL and +title.

+

Empty.

+ + diff --git a/MarkdownTest/Tests_2004/Links, inline style.text-res b/MarkdownTest/Tests_2004/Links, inline style.text-res new file mode 100644 index 0000000..0125b63 --- /dev/null +++ b/MarkdownTest/Tests_2004/Links, inline style.text-res @@ -0,0 +1,17 @@ + + + + + + + +

Just a URL.

+

URL and title.

+

URL and +title.

+

URL and +title.

+

Empty.

+ + diff --git a/MarkdownTest/Tests_2004/Links, reference style.html b/MarkdownTest/Tests_2004/Links, reference style.html new file mode 100644 index 0000000..cf4d833 --- /dev/null +++ b/MarkdownTest/Tests_2004/Links, reference style.html @@ -0,0 +1,18 @@ +

Foo bar.

+ +

Foo bar.

+ +

Foo bar.

+ +

With embedded [brackets].

+ +

Indented once.

+ +

Indented twice.

+ +

Indented thrice.

+ +

Indented [four][] times.

+ +
[four]: /url
+
diff --git a/MarkdownTest/Tests_2004/Links, reference style.text b/MarkdownTest/Tests_2004/Links, reference style.text new file mode 100644 index 0000000..b2fa734 --- /dev/null +++ b/MarkdownTest/Tests_2004/Links, reference style.text @@ -0,0 +1,31 @@ +Foo [bar] [1]. + +Foo [bar][1]. + +Foo [bar] +[1]. + +[1]: /url/ "Title" + + +With [embedded [brackets]] [b]. + + +Indented [once][]. + +Indented [twice][]. + +Indented [thrice][]. + +Indented [four][] times. + + [once]: /url + + [twice]: /url + + [thrice]: /url + + [four]: /url + + +[b]: /url/ diff --git a/MarkdownTest/Tests_2004/Links, reference style.text-out b/MarkdownTest/Tests_2004/Links, reference style.text-out new file mode 100644 index 0000000..04ae0cd --- /dev/null +++ b/MarkdownTest/Tests_2004/Links, reference style.text-out @@ -0,0 +1,22 @@ + + + + + + + +

Foo bar.

+

Foo bar.

+

Foo bar.

+

With embedded [brackets].

+

Indented once.

+

Indented twice.

+

Indented thrice.

+

Indented [four][] times.

+
+[four]: /url
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Links, reference style.text-res b/MarkdownTest/Tests_2004/Links, reference style.text-res new file mode 100644 index 0000000..04ae0cd --- /dev/null +++ b/MarkdownTest/Tests_2004/Links, reference style.text-res @@ -0,0 +1,22 @@ + + + + + + + +

Foo bar.

+

Foo bar.

+

Foo bar.

+

With embedded [brackets].

+

Indented once.

+

Indented twice.

+

Indented thrice.

+

Indented [four][] times.

+
+[four]: /url
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Links-in-Headers.text-out b/MarkdownTest/Tests_2004/Links-in-Headers.text-out new file mode 100644 index 0000000..defddbf --- /dev/null +++ b/MarkdownTest/Tests_2004/Links-in-Headers.text-out @@ -0,0 +1,9 @@ +

A plain header

+

Let's first have a plain header

+

An underlined header

+

(That's also useful)

+

A header with a link

+

First with a hash

+

Another with a link

+

This time underlined

+ diff --git a/MarkdownTest/Tests_2004/Links-in-Headers.text-res b/MarkdownTest/Tests_2004/Links-in-Headers.text-res new file mode 100644 index 0000000..cc6cfcf --- /dev/null +++ b/MarkdownTest/Tests_2004/Links-in-Headers.text-res @@ -0,0 +1,9 @@ +

A plain header

+

Let's first have a plain header

+

An underlined header

+

(That's also useful)

+

A header with a link

+

First with a hash

+

Another with a link

+

This time underlined

+ diff --git a/MarkdownTest/Tests_2004/Literal quotes in titles.html b/MarkdownTest/Tests_2004/Literal quotes in titles.html new file mode 100644 index 0000000..611c1ac --- /dev/null +++ b/MarkdownTest/Tests_2004/Literal quotes in titles.html @@ -0,0 +1,3 @@ +

Foo bar.

+ +

Foo bar.

diff --git a/MarkdownTest/Tests_2004/Literal quotes in titles.text b/MarkdownTest/Tests_2004/Literal quotes in titles.text new file mode 100644 index 0000000..29d0e42 --- /dev/null +++ b/MarkdownTest/Tests_2004/Literal quotes in titles.text @@ -0,0 +1,7 @@ +Foo [bar][]. + +Foo [bar](/url/ "Title with "quotes" inside"). + + + [bar]: /url/ "Title with "quotes" inside" + diff --git a/MarkdownTest/Tests_2004/Literal quotes in titles.text-out b/MarkdownTest/Tests_2004/Literal quotes in titles.text-out new file mode 100644 index 0000000..3fd6fbc --- /dev/null +++ b/MarkdownTest/Tests_2004/Literal quotes in titles.text-out @@ -0,0 +1,14 @@ + + + + + + + +

Foo bar.

+

Foo bar.

+ + diff --git a/MarkdownTest/Tests_2004/Literal quotes in titles.text-res b/MarkdownTest/Tests_2004/Literal quotes in titles.text-res new file mode 100644 index 0000000..3fd6fbc --- /dev/null +++ b/MarkdownTest/Tests_2004/Literal quotes in titles.text-res @@ -0,0 +1,14 @@ + + + + + + + +

Foo bar.

+

Foo bar.

+ + diff --git a/MarkdownTest/Tests_2004/Markdown Documentation - Basics.html b/MarkdownTest/Tests_2004/Markdown Documentation - Basics.html new file mode 100644 index 0000000..d5bdbb2 --- /dev/null +++ b/MarkdownTest/Tests_2004/Markdown Documentation - Basics.html @@ -0,0 +1,314 @@ +

Markdown: Basics

+ + + +

Getting the Gist of Markdown's Formatting Syntax

+ +

This page offers a brief overview of what it's like to use Markdown. +The syntax page provides complete, detailed documentation for +every feature, but Markdown should be very easy to pick up simply by +looking at a few examples of it in action. The examples on this page +are written in a before/after style, showing example syntax and the +HTML output produced by Markdown.

+ +

It's also helpful to simply try Markdown out; the Dingus is a +web application that allows you type your own Markdown-formatted text +and translate it to XHTML.

+ +

Note: This document is itself written using Markdown; you +can see the source for it by adding '.text' to the URL.

+ +

Paragraphs, Headers, Blockquotes

+ +

A paragraph is simply one or more consecutive lines of text, separated +by one or more blank lines. (A blank line is any line that looks like a +blank line -- a line containing nothing spaces or tabs is considered +blank.) Normal paragraphs should not be intended with spaces or tabs.

+ +

Markdown offers two styles of headers: Setext and atx. +Setext-style headers for <h1> and <h2> are created by +"underlining" with equal signs (=) and hyphens (-), respectively. +To create an atx-style header, you put 1-6 hash marks (#) at the +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 Second Level Header
+---------------------
+
+Now is the time for all good men to come to
+the aid of their country. This is just a
+regular paragraph.
+
+The quick brown fox jumped over the lazy
+dog's back.
+
+### Header 3
+
+> This is a blockquote.
+> 
+> This is the second paragraph in the blockquote.
+>
+> ## This is an H2 in a blockquote
+
+ +

Output:

+ +
<h1>A First Level Header</h1>
+
+<h2>A Second Level Header</h2>
+
+<p>Now is the time for all good men to come to
+the aid of their country. This is just a
+regular paragraph.</p>
+
+<p>The quick brown fox jumped over the lazy
+dog's back.</p>
+
+<h3>Header 3</h3>
+
+<blockquote>
+    <p>This is a blockquote.</p>
+
+    <p>This is the second paragraph in the blockquote.</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 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>.
+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.
+*   Gum.
+*   Booze.
+
+ +

this:

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

and this:

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

all produce the same output:

+ +
<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
+2.  Green
+3.  Blue
+
+ +

Output:

+ +
<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.
+
+    With multiple paragraphs.
+
+*   Another item in the list.
+
+ +

Output:

+ +
<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/).
+
+ +

Output:

+ +
<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").
+
+ +

Output:

+ +
<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
+[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/"
+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
+[The New York Times][NY Times].
+
+[ny times]: http://www.nytimes.com/
+
+ +

Output:

+ +
<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")
+
+ +

Reference-style:

+ +
![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" />
+
+ +

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 wish SmartyPants used named entities like `&mdash;`
+instead of decimal-encoded entites like `&#8212;`.
+
+ +

Output:

+ +
<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,
+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,
+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>
+
diff --git a/MarkdownTest/Tests_2004/Markdown Documentation - Basics.text b/MarkdownTest/Tests_2004/Markdown Documentation - Basics.text new file mode 100644 index 0000000..486055c --- /dev/null +++ b/MarkdownTest/Tests_2004/Markdown Documentation - Basics.text @@ -0,0 +1,306 @@ +Markdown: Basics +================ + + + + +Getting the Gist of Markdown's Formatting Syntax +------------------------------------------------ + +This page offers a brief overview of what it's like to use Markdown. +The [syntax page] [s] provides complete, detailed documentation for +every feature, but Markdown should be very easy to pick up simply by +looking at a few examples of it in action. The examples on this page +are written in a before/after style, showing example syntax and the +HTML output produced by Markdown. + +It's also helpful to simply try Markdown out; the [Dingus] [d] is a +web application that allows you type your own Markdown-formatted text +and translate it to XHTML. + +**Note:** This document is itself written using Markdown; you +can [see the source for it by adding '.text' to the URL] [src]. + + [s]: /projects/markdown/syntax "Markdown Syntax" + [d]: /projects/markdown/dingus "Markdown Dingus" + [src]: /projects/markdown/basics.text + + +## Paragraphs, Headers, Blockquotes ## + +A paragraph is simply one or more consecutive lines of text, separated +by one or more blank lines. (A blank line is any line that looks like a +blank line -- a line containing nothing spaces or tabs is considered +blank.) Normal paragraphs should not be intended with spaces or tabs. + +Markdown offers two styles of headers: *Setext* and *atx*. +Setext-style headers for `

` and `

` are created by +"underlining" with equal signs (`=`) and hyphens (`-`), respectively. +To create an atx-style header, you put 1-6 hash marks (`#`) at the +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 Second Level Header + --------------------- + + Now is the time for all good men to come to + the aid of their country. This is just a + regular paragraph. + + The quick brown fox jumped over the lazy + dog's back. + + ### Header 3 + + > This is a blockquote. + > + > This is the second paragraph in the blockquote. + > + > ## This is an H2 in a blockquote + + +Output: + +

A First Level Header

+ +

A Second Level Header

+ +

Now is the time for all good men to come to + the aid of their country. This is just a + regular paragraph.

+ +

The quick brown fox jumped over the lazy + dog's back.

+ +

Header 3

+ +
+

This is a blockquote.

+ +

This is the second paragraph in the blockquote.

+ +

This is an H2 in a 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 also_. + + Use two asterisks for **strong emphasis**. + Or, if you prefer, __use two underscores instead__. + +Output: + +

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.

+ + + +## Lists ## + +Unordered (bulleted) lists use asterisks, pluses, and hyphens (`*`, +`+`, and `-`) as list markers. These three markers are +interchangable; this: + + * Candy. + * Gum. + * Booze. + +this: + + + Candy. + + Gum. + + Booze. + +and this: + + - Candy. + - Gum. + - Booze. + +all produce the same output: + +
    +
  • Candy.
  • +
  • Gum.
  • +
  • Booze.
  • +
+ +Ordered (numbered) lists use regular numbers, followed by periods, as +list markers: + + 1. Red + 2. Green + 3. Blue + +Output: + +
    +
  1. Red
  2. +
  3. Green
  4. +
  5. Blue
  6. +
+ +If you put blank lines between items, you'll get `

` 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. + + With multiple paragraphs. + + * Another item in the list. + +Output: + +

    +
  • A list item.

    +

    With multiple paragraphs.

  • +
  • Another item in the list.

  • +
+ + + +### 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/). + +Output: + +

This is an + example link.

+ +Optionally, you may include a title attribute in the parentheses: + + This is an [example link](http://example.com/ "With a Title"). + +Output: + +

This is an + example link.

+ +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 + [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: + +

I get 10 times more traffic from Google than from Yahoo or MSN.

+ +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 + [The New York Times][NY Times]. + + [ny times]: http://www.nytimes.com/ + +Output: + +

I start my morning with a cup of coffee and + The New York Times.

+ + +### Images ### + +Image syntax is very much like link syntax. + +Inline (titles are optional): + + ![alt text](/path/to/img.jpg "Title") + +Reference-style: + + ![alt text][id] + + [id]: /path/to/img.jpg "Title" + +Both of the above examples produce the same output: + + alt text + + + +### 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 `` tags. + + I wish SmartyPants used named entities like `—` + instead of decimal-encoded entites like `—`. + +Output: + +

I strongly recommend against using any + <blink> tags.

+ +

I wish SmartyPants used named entities like + &mdash; instead of decimal-encoded + entites like &#8212;.

+ + +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, + you've got to put paragraph tags in your blockquotes: + +
+

For example.

+
+ +Output: + +

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>
+    
diff --git a/MarkdownTest/Tests_2004/Markdown Documentation - Basics.text-out b/MarkdownTest/Tests_2004/Markdown Documentation - Basics.text-out new file mode 100644 index 0000000..65b90fa --- /dev/null +++ b/MarkdownTest/Tests_2004/Markdown Documentation - Basics.text-out @@ -0,0 +1,321 @@ + + + + + + + +

Markdown: Basics

+ +

Getting the Gist of Markdown's Formatting Syntax

+

This page offers a brief overview of what it's like to use +Markdown. The syntax page provides complete, detailed +documentation for every feature, but Markdown should be very easy +to pick up simply by looking at a few examples of it in action. The +examples on this page are written in a before/after style, showing +example syntax and the HTML output produced by Markdown.

+

It's also helpful to simply try Markdown out; the Dingus is a +web application that allows you type your own Markdown-formatted +text and translate it to XHTML.

+

Note: This document is itself written using +Markdown; you can see the +source for it by adding '.text' to the URL.

+

Paragraphs, Headers, Blockquotes

+

A paragraph is simply one or more consecutive lines of text, +separated by one or more blank lines. (A blank line is any line +that looks like a blank line -- a line containing nothing spaces or +tabs is considered blank.) Normal paragraphs should not be intended +with spaces or tabs.

+

Markdown offers two styles of headers: Setext and +atx. Setext-style headers for <h1> and +<h2> are created by "underlining" with equal +signs (=) and hyphens (-), respectively. +To create an atx-style header, you put 1-6 hash marks +(#) at the 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 Second Level Header
+---------------------
+
+Now is the time for all good men to come to
+the aid of their country. This is just a
+regular paragraph.
+
+The quick brown fox jumped over the lazy
+dog's back.
+
+### Header 3
+
+> This is a blockquote.
+> 
+> This is the second paragraph in the blockquote.
+>
+> ## This is an H2 in a blockquote
+
+
+

Output:

+
+<h1>A First Level Header</h1>
+
+<h2>A Second Level Header</h2>
+
+<p>Now is the time for all good men to come to
+the aid of their country. This is just a
+regular paragraph.</p>
+
+<p>The quick brown fox jumped over the lazy
+dog's back.</p>
+
+<h3>Header 3</h3>
+
+<blockquote>
+    <p>This is a blockquote.</p>
+
+    <p>This is the second paragraph in the blockquote.</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 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>.
+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.
+*   Gum.
+*   Booze.
+
+
+

this:

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

and this:

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

all produce the same output:

+
+<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
+2.  Green
+3.  Blue
+
+
+

Output:

+
+<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.
+
+    With multiple paragraphs.
+
+*   Another item in the list.
+
+
+

Output:

+
+<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/).
+
+
+

Output:

+
+<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").
+
+
+

Output:

+
+<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
+[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/"
+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
+[The New York Times][NY Times].
+
+[ny times]: http://www.nytimes.com/
+
+
+

Output:

+
+<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")
+
+
+

Reference-style:

+
+![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" />
+
+
+

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 wish SmartyPants used named entities like `&mdash;`
+instead of decimal-encoded entites like `&#8212;`.
+
+
+

Output:

+
+<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,
+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,
+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>
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Markdown Documentation - Basics.text-res b/MarkdownTest/Tests_2004/Markdown Documentation - Basics.text-res new file mode 100644 index 0000000..65b90fa --- /dev/null +++ b/MarkdownTest/Tests_2004/Markdown Documentation - Basics.text-res @@ -0,0 +1,321 @@ + + + + + + + +

Markdown: Basics

+ +

Getting the Gist of Markdown's Formatting Syntax

+

This page offers a brief overview of what it's like to use +Markdown. The syntax page provides complete, detailed +documentation for every feature, but Markdown should be very easy +to pick up simply by looking at a few examples of it in action. The +examples on this page are written in a before/after style, showing +example syntax and the HTML output produced by Markdown.

+

It's also helpful to simply try Markdown out; the Dingus is a +web application that allows you type your own Markdown-formatted +text and translate it to XHTML.

+

Note: This document is itself written using +Markdown; you can see the +source for it by adding '.text' to the URL.

+

Paragraphs, Headers, Blockquotes

+

A paragraph is simply one or more consecutive lines of text, +separated by one or more blank lines. (A blank line is any line +that looks like a blank line -- a line containing nothing spaces or +tabs is considered blank.) Normal paragraphs should not be intended +with spaces or tabs.

+

Markdown offers two styles of headers: Setext and +atx. Setext-style headers for <h1> and +<h2> are created by "underlining" with equal +signs (=) and hyphens (-), respectively. +To create an atx-style header, you put 1-6 hash marks +(#) at the 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 Second Level Header
+---------------------
+
+Now is the time for all good men to come to
+the aid of their country. This is just a
+regular paragraph.
+
+The quick brown fox jumped over the lazy
+dog's back.
+
+### Header 3
+
+> This is a blockquote.
+> 
+> This is the second paragraph in the blockquote.
+>
+> ## This is an H2 in a blockquote
+
+
+

Output:

+
+<h1>A First Level Header</h1>
+
+<h2>A Second Level Header</h2>
+
+<p>Now is the time for all good men to come to
+the aid of their country. This is just a
+regular paragraph.</p>
+
+<p>The quick brown fox jumped over the lazy
+dog's back.</p>
+
+<h3>Header 3</h3>
+
+<blockquote>
+    <p>This is a blockquote.</p>
+
+    <p>This is the second paragraph in the blockquote.</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 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>.
+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.
+*   Gum.
+*   Booze.
+
+
+

this:

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

and this:

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

all produce the same output:

+
+<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
+2.  Green
+3.  Blue
+
+
+

Output:

+
+<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.
+
+    With multiple paragraphs.
+
+*   Another item in the list.
+
+
+

Output:

+
+<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/).
+
+
+

Output:

+
+<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").
+
+
+

Output:

+
+<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
+[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/"
+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
+[The New York Times][NY Times].
+
+[ny times]: http://www.nytimes.com/
+
+
+

Output:

+
+<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")
+
+
+

Reference-style:

+
+![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" />
+
+
+

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 wish SmartyPants used named entities like `&mdash;`
+instead of decimal-encoded entites like `&#8212;`.
+
+
+

Output:

+
+<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,
+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,
+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>
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Markdown Documentation - Syntax.html b/MarkdownTest/Tests_2004/Markdown Documentation - Syntax.html new file mode 100644 index 0000000..5c01306 --- /dev/null +++ b/MarkdownTest/Tests_2004/Markdown Documentation - Syntax.html @@ -0,0 +1,942 @@ +

Markdown: Syntax

+ + + + + +

Note: This document is itself written using Markdown; you +can see the source for it by adding '.text' to the URL.

+ +
+ +

Overview

+ +

Philosophy

+ +

Markdown is intended to be as easy-to-read and easy-to-write as is feasible.

+ +

Readability, however, is emphasized above all else. A Markdown-formatted +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 Setext, atx, Textile, reStructuredText, +Grutatext, and EtText -- the single biggest source of +inspiration for Markdown's syntax is the format of plain text email.

+ +

To this end, Markdown's syntax is comprised entirely of punctuation +characters, which punctuation characters have been carefully chosen so +as to look like what they mean. E.g., asterisks around a word actually +look like *emphasis*. Markdown lists look like, well, lists. Even +blockquotes look like quoted passages of text, assuming you've ever +used email.

+ +

Inline HTML

+ +

Markdown's syntax is intended for one purpose: to be used as a +format for writing for the web.

+ +

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 not 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 publishing format; Markdown is a writing +format. Thus, Markdown's formatting syntax only addresses issues that +can be conveyed in plain text.

+ +

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 +indicate that you're switching from Markdown to HTML; you just use +the tags.

+ +

The only restrictions are that block-level HTML elements -- e.g. <div>, +<table>, <pre>, <p>, 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) <p> tags around HTML block-level tags.

+ +

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

+ +
This is a regular paragraph.
+
+<table>
+    <tr>
+        <td>Foo</td>
+    </tr>
+</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.

+ +

Span-level HTML tags -- e.g. <span>, <cite>, or <del> -- 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 <a> or <img> tags instead of Markdown's +link or image syntax, go right ahead.

+ +

Unlike block-level HTML tags, Markdown syntax is processed within +span-level tags.

+ +

Automatic Escaping for Special Characters

+ +

In HTML, there are two characters that demand special treatment: < +and &. Left angle brackets are used to start tags; ampersands are +used to denote HTML entities. If you want to use them as literal +characters, you must escape them as entities, e.g. &lt;, and +&amp;.

+ +

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
+
+ +

you need to encode the URL as:

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

+ +

Markdown allows you to use these characters naturally, taking care of +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;
+
+ +

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

+ +
AT&T
+
+ +

Markdown will translate it to:

+ +
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
+
+ +

Markdown will translate it to:

+ +
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 +terrible format for writing about HTML syntax, because every single < +and & in your example code needs to be escaped.)

+ +
+ +

Block Elements

+ +

Paragraphs and Line Breaks

+ +

A paragraph is simply one or more consecutive lines of text, separated +by one or more blank lines. (A blank line is any line that looks like a +blank line -- a line containing nothing but spaces or tabs is considered +blank.) Normal paragraphs should not be intended with spaces or tabs.

+ +

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 +character in a paragraph into a <br /> tag.

+ +

When you do want to insert a <br /> break tag using Markdown, you +end a line with two or more spaces, then type return.

+ +

Yes, this takes a tad more effort to create a <br />, but a simplistic +"every line break is a <br />" rule wouldn't work for Markdown. +Markdown's email-style blockquoting and multi-paragraph list items +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 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 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 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,
+> 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,
+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 nested blockquote.
+>
+> Back to the first level.
+
+ +

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

+ +
> ## This is a header.
+> 
+> 1.   This is the first list item.
+> 2.   This is the second list item.
+> 
+> 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.

+ +

Lists

+ +

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

+ +

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

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

is equivalent to:

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

and:

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

Ordered lists use numbers followed by periods:

+ +
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>
+<li>Bird</li>
+<li>McHale</li>
+<li>Parish</li>
+</ol>
+
+ +

If you instead wrote the list in Markdown like this:

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

or even:

+ +
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. +But if you want to be lazy, you don't have to.

+ +

If you do use lazy list numbering, however, you should still start the +list with the number 1. At some point in the future, Markdown may support +starting ordered lists at an arbitrary number.

+ +

List markers typically start at the left margin, but may be indented by +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.
+    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.
+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
+*   Magic
+
+ +

will turn into:

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

But this:

+ +
*   Bird
+
+*   Magic
+
+ +

will turn into:

+ +
<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
+    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.
+
+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 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:
+
+    > 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:
+
+        <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.
+
+ +

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

Code Blocks

+ +

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 <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 code block.
+
+ +

Markdown will generate:

+ +
<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:
+
+    tell application "Foo"
+        beep
+    end tell
+
+ +

will turn into:

+ +
<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 >) +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">
+        &copy; 2004 Foo Corporation
+    </div>
+
+ +

will turn into:

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

+ +

Horizontal Rules

+ +

You can produce a horizontal rule tag (<hr />) by placing three or +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:

+ +
* * *
+
+***
+
+*****
+
+- - -
+
+---------------------------------------
+
+_ _ _
+
+ +
+ +

Span Elements

+ + + +

Markdown supports two style of links: inline and reference.

+ +

In both styles, the link text is delimited by [square brackets].

+ +

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 optional +title for the link, surrounded in quotes. For example:

+ +
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">
+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.
+
+ +

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

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

+ +
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"
+
+ +

That is:

+ +
    +
  • Square brackets containing the link identifier (optionally +indented from the left margin using up to three spaces);
  • +
  • followed by a colon;
  • +
  • followed by one or more spaces (or tabs);
  • +
  • followed by the URL for the link;
  • +
  • optionally followed by a title attribute for the link, enclosed +in double or single quotes.
  • +
+ +

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

+ +
[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
+    "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]
+
+ +

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][]
+
+ +

And then define the link:

+ +
[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.
+
+ +

And then define the link:

+ +
[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
+[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
+[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/"
+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")
+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 +reference-style links, the paragraph itself is only 81 characters +long; with inline-style links, it's 176 characters; and as raw HTML, +it's 234 characters. In the raw HTML, there's more markup than there +is text.

+ +

With Markdown's reference-style links, a source document much more +closely resembles the final output, as rendered in a browser. By +allowing you to move the markup-related metadata out of the paragraph, +you can add links without interrupting the narrative flow of your +prose.

+ +

Emphasis

+ +

Markdown treats asterisks (*) and underscores (_) as indicators of +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 underscores_
+
+**double asterisks**
+
+__double underscores__
+
+ +

will produce:

+ +
<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
+
+ +

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\*
+
+ +

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

will produce:

+ +
<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.``
+
+ +

which will produce this:

+ +
<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 backtick-delimited string in a code span: `` `foo` ``
+
+ +

will produce:

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

into:

+ +
<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;`.
+
+ +

to produce:

+ +
<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 +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 "Optional title")
+
+ +

That is:

+ +
    +
  • An exclamation mark: !;
  • +
  • followed by a set of square brackets, containing the alt +attribute text for the image;
  • +
  • followed by a set of parentheses, containing the URL or path to +the image, and an optional title attribute enclosed in double +or single quotes.
  • +
+ +

Reference-style image syntax looks like this:

+ +
![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"
+
+ +

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.

+ +
+ +

Miscellaneous

+ + + +

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/>
+
+ +

Markdown will turn this into:

+ +
<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>
+
+ +

into something like this:

+ +
<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 +them. It's better than nothing, but an address published in this way +will probably eventually start receiving spam.)

+ +

Backslash Escapes

+ +

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 <em> tag), you can backslashes +before the asterisks, like this:

+ +
\*literal asterisks\*
+
+ +

Markdown provides backslash escapes for the following characters:

+ +
\   backslash
+`   backtick
+*   asterisk
+_   underscore
+{}  curly braces
+[]  square brackets
+()  parentheses
+#   hash mark
++   plus sign
+-   minus sign (hyphen)
+.   dot
+!   exclamation mark
+
diff --git a/MarkdownTest/Tests_2004/Markdown Documentation - Syntax.text b/MarkdownTest/Tests_2004/Markdown Documentation - Syntax.text new file mode 100644 index 0000000..dabd75c --- /dev/null +++ b/MarkdownTest/Tests_2004/Markdown Documentation - Syntax.text @@ -0,0 +1,888 @@ +Markdown: Syntax +================ + + + + +* [Overview](#overview) + * [Philosophy](#philosophy) + * [Inline HTML](#html) + * [Automatic Escaping for Special Characters](#autoescape) +* [Block Elements](#block) + * [Paragraphs and Line Breaks](#p) + * [Headers](#header) + * [Blockquotes](#blockquote) + * [Lists](#list) + * [Code Blocks](#precode) + * [Horizontal Rules](#hr) +* [Span Elements](#span) + * [Links](#link) + * [Emphasis](#em) + * [Code](#code) + * [Images](#img) +* [Miscellaneous](#misc) + * [Backslash Escapes](#backslash) + * [Automatic Links](#autolink) + + +**Note:** This document is itself written using Markdown; you +can [see the source for it by adding '.text' to the URL][src]. + + [src]: /projects/markdown/syntax.text + +* * * + +

Overview

+ +

Philosophy

+ +Markdown is intended to be as easy-to-read and easy-to-write as is feasible. + +Readability, however, is emphasized above all else. A Markdown-formatted +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 [Setext] [1], [atx] [2], [Textile] [3], [reStructuredText] [4], +[Grutatext] [5], and [EtText] [6] -- the single biggest source of +inspiration for Markdown's syntax is the format of plain text email. + + [1]: http://docutils.sourceforge.net/mirror/setext.html + [2]: http://www.aaronsw.com/2002/atx/ + [3]: http://textism.com/tools/textile/ + [4]: http://docutils.sourceforge.net/rst.html + [5]: http://www.triptico.com/software/grutatxt.html + [6]: http://ettext.taint.org/doc/ + +To this end, Markdown's syntax is comprised entirely of punctuation +characters, which punctuation characters have been carefully chosen so +as to look like what they mean. E.g., asterisks around a word actually +look like \*emphasis\*. Markdown lists look like, well, lists. Even +blockquotes look like quoted passages of text, assuming you've ever +used email. + + + +

Inline HTML

+ +Markdown's syntax is intended for one purpose: to be used as a +format for *writing* for the web. + +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 *not* 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 *publishing* format; Markdown is a *writing* +format. Thus, Markdown's formatting syntax only addresses issues that +can be conveyed in plain text. + +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 +indicate that you're switching from Markdown to HTML; you just use +the tags. + +The only restrictions are that block-level HTML elements -- e.g. `
`, +``, `
`, `

`, 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) `

` tags around HTML block-level tags. + +For example, to add an HTML table to a Markdown article: + + This is a regular paragraph. + +

+ + + +
Foo
+ + 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. + +Span-level HTML tags -- e.g. ``, ``, or `` -- 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 `` or `` tags instead of Markdown's +link or image syntax, go right ahead. + +Unlike block-level HTML tags, Markdown syntax *is* processed within +span-level tags. + + +

Automatic Escaping for Special Characters

+ +In HTML, there are two characters that demand special treatment: `<` +and `&`. Left angle brackets are used to start tags; ampersands are +used to denote HTML entities. If you want to use them as literal +characters, you must escape them as entities, e.g. `<`, and +`&`. + +Ampersands in particular are bedeviling for web writers. If you want to +write about 'AT&T', you need to write '`AT&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 + +you need to encode the URL as: + + http://images.google.com/images?num=30&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. + +Markdown allows you to use these characters naturally, taking care of +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 `&`. + +So, if you want to include a copyright symbol in your article, you can write: + + © + +and Markdown will leave it alone. But if you write: + + AT&T + +Markdown will translate it to: + + AT&T + +Similarly, because Markdown supports [inline HTML](#html), if you use +angle brackets as delimiters for HTML tags, Markdown will treat them as +such. But if you write: + + 4 < 5 + +Markdown will translate it to: + + 4 < 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 +terrible format for writing about HTML syntax, because every single `<` +and `&` in your example code needs to be escaped.) + + +* * * + + +

Block Elements

+ + +

Paragraphs and Line Breaks

+ +A paragraph is simply one or more consecutive lines of text, separated +by one or more blank lines. (A blank line is any line that looks like a +blank line -- a line containing nothing but spaces or tabs is considered +blank.) Normal paragraphs should not be intended with spaces or tabs. + +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 +character in a paragraph into a `
` tag. + +When you *do* want to insert a `
` break tag using Markdown, you +end a line with two or more spaces, then type return. + +Yes, this takes a tad more effort to create a `
`, but a simplistic +"every line break is a `
`" rule wouldn't work for Markdown. +Markdown's email-style [blockquoting][bq] and multi-paragraph [list items][l] +work best -- and look better -- when you format them with hard breaks. + + [bq]: #blockquote + [l]: #list + + + + + +Markdown supports two styles of headers, [Setext] [1] and [atx] [2]. + +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 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 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 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, + > 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, + 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 nested blockquote. + > + > Back to the first level. + +Blockquotes can contain other Markdown elements, including headers, lists, +and code blocks: + + > ## This is a header. + > + > 1. This is the first list item. + > 2. This is the second list item. + > + > 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. + + +

Lists

+ +Markdown supports ordered (numbered) and unordered (bulleted) lists. + +Unordered lists use asterisks, pluses, and hyphens -- interchangably +-- as list markers: + + * Red + * Green + * Blue + +is equivalent to: + + + Red + + Green + + Blue + +and: + + - Red + - Green + - Blue + +Ordered lists use numbers followed by periods: + + 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: + +
    +
  1. Bird
  2. +
  3. McHale
  4. +
  5. Parish
  6. +
+ +If you instead wrote the list in Markdown like this: + + 1. Bird + 1. McHale + 1. Parish + +or even: + + 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. +But if you want to be lazy, you don't have to. + +If you do use lazy list numbering, however, you should still start the +list with the number 1. At some point in the future, Markdown may support +starting ordered lists at an arbitrary number. + +List markers typically start at the left margin, but may be indented by +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. + 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. + 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 `

` tags in the HTML output. For example, this input: + + * Bird + * Magic + +will turn into: + +

    +
  • Bird
  • +
  • Magic
  • +
+ +But this: + + * Bird + + * Magic + +will turn into: + +
    +
  • Bird

  • +
  • Magic

  • +
+ +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 + 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. + + 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 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: + + > 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: + + + + +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. + +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. + + + +

Code Blocks

+ +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 `
` and `` 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 code block.
+
+Markdown will generate:
+
+    

This is a normal paragraph:

+ +
This is a code block.
+    
+ +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: + + tell application "Foo" + beep + end tell + +will turn into: + +

Here is an example of AppleScript:

+ +
tell application "Foo"
+        beep
+    end tell
+    
+ +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 `>`) +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: + + + +will turn into: + +
<div class="footer">
+        &copy; 2004 Foo Corporation
+    </div>
+    
+ +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. + + + +

Horizontal Rules

+ +You can produce a horizontal rule tag (`
`) by placing three or +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: + + * * * + + *** + + ***** + + - - - + + --------------------------------------- + + _ _ _ + + +* * * + +

Span Elements

+ + + +Markdown supports two style of links: *inline* and *reference*. + +In both styles, the link text is delimited by [square brackets]. + +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 *optional* +title for the link, surrounded in quotes. For example: + + This is [an example](http://example.com/ "Title") inline link. + + [This link](http://example.net/) has no title attribute. + +Will produce: + +

This is + an example inline link.

+ +

This link has no + title attribute.

+ +If you're referring to a local resource on the same server, you can +use relative paths: + + 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. + +You can optionally use a space to separate the sets of brackets: + + 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" + +That is: + +* Square brackets containing the link identifier (optionally + indented from the left margin using up to three spaces); +* followed by a colon; +* followed by one or more spaces (or tabs); +* followed by the URL for the link; +* optionally followed by a title attribute for the link, enclosed + in double or single quotes. + +The link URL may, optionally, be surrounded by angle brackets: + + [id]: "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 + "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] + +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][] + +And then define the link: + + [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. + +And then define the link: + + [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 + [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 + [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: + +

I get 10 times more traffic from Google than from + Yahoo + or MSN.

+ +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") + 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 +reference-style links, the paragraph itself is only 81 characters +long; with inline-style links, it's 176 characters; and as raw HTML, +it's 234 characters. In the raw HTML, there's more markup than there +is text. + +With Markdown's reference-style links, a source document much more +closely resembles the final output, as rendered in a browser. By +allowing you to move the markup-related metadata out of the paragraph, +you can add links without interrupting the narrative flow of your +prose. + + +

Emphasis

+ +Markdown treats asterisks (`*`) and underscores (`_`) as indicators of +emphasis. Text wrapped with one `*` or `_` will be wrapped with an +HTML `` tag; double `*`'s or `_`'s will be wrapped with an HTML +`` tag. E.g., this input: + + *single asterisks* + + _single underscores_ + + **double asterisks** + + __double underscores__ + +will produce: + + single asterisks + + single underscores + + double asterisks + + double underscores + +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 + +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\* + + + +

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. + +will produce: + +

Use the printf() function.

+ +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.`` + +which will produce this: + +

There is a literal backtick (`) here.

+ +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 backtick-delimited string in a code span: `` `foo` `` + +will produce: + +

A single backtick in a code span: `

+ +

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

+ +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 `` tags. + +into: + +

Please don't use any <blink> tags.

+ +You can write this: + + `—` is the decimal-encoded equivalent of `—`. + +to produce: + +

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

+ + + +

Images

+ +Admittedly, it's fairly difficult to devise a "natural" syntax for +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 "Optional title") + +That is: + +* An exclamation mark: `!`; +* followed by a set of square brackets, containing the `alt` + attribute text for the image; +* followed by a set of parentheses, containing the URL or path to + the image, and an optional `title` attribute enclosed in double + or single quotes. + +Reference-style image syntax looks like this: + + ![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" + +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 `` tags. + + +* * * + + +

Miscellaneous

+ + + +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: + + + +Markdown will turn this into: + + http://example.com/ + +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: + + + +into something like this: + + address@exa + mple.com + +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 +them. It's better than nothing, but an address published in this way +will probably eventually start receiving spam.) + + + +

Backslash Escapes

+ +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 `` tag), you can backslashes +before the asterisks, like this: + + \*literal asterisks\* + +Markdown provides backslash escapes for the following characters: + + \ backslash + ` backtick + * asterisk + _ underscore + {} curly braces + [] square brackets + () parentheses + # hash mark + + plus sign + - minus sign (hyphen) + . dot + ! exclamation mark + diff --git a/MarkdownTest/Tests_2004/Markdown Documentation - Syntax.text-out b/MarkdownTest/Tests_2004/Markdown Documentation - Syntax.text-out new file mode 100644 index 0000000..ecf2e70 --- /dev/null +++ b/MarkdownTest/Tests_2004/Markdown Documentation - Syntax.text-out @@ -0,0 +1,957 @@ + + + + + + + +

Markdown: Syntax

+ + +

Note: This document is itself written using +Markdown; you can see the +source for it by adding '.text' to the URL.

+
+

Overview

+

Philosophy

+

Markdown is intended to be as easy-to-read and easy-to-write as +is feasible.

+

Readability, however, is emphasized above all else. A +Markdown-formatted 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 +Setext, +atx, Textile, reStructuredText, +Grutatext, and +EtText -- the single +biggest source of inspiration for Markdown's syntax is the format +of plain text email.

+

To this end, Markdown's syntax is comprised entirely of +punctuation characters, which punctuation characters have been +carefully chosen so as to look like what they mean. E.g., asterisks +around a word actually look like *emphasis*. Markdown lists look +like, well, lists. Even blockquotes look like quoted passages of +text, assuming you've ever used email.

+

Inline HTML

+

Markdown's syntax is intended for one purpose: to be used as a +format for writing for the web.

+

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 not 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 publishing format; +Markdown is a writing format. Thus, Markdown's formatting +syntax only addresses issues that can be conveyed in plain +text.

+

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 indicate that you're switching from Markdown to HTML; you just +use the tags.

+

The only restrictions are that block-level HTML elements -- e.g. +<div>, <table>, +<pre>, <p>, 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) +<p> tags around HTML block-level tags.

+

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

+
+This is a regular paragraph.
+
+<table>
+    <tr>
+        <td>Foo</td>
+    </tr>
+</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.

+

Span-level HTML tags -- e.g. <span>, +<cite>, or <del> -- 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 <a> or +<img> tags instead of Markdown's link or image +syntax, go right ahead.

+

Unlike block-level HTML tags, Markdown syntax is +processed within span-level tags.

+

Automatic Escaping for Special Characters

+

In HTML, there are two characters that demand special treatment: +< and &. Left angle brackets are +used to start tags; ampersands are used to denote HTML entities. If +you want to use them as literal characters, you must escape them as +entities, e.g. &lt;, and +&amp;.

+

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
+
+
+

you need to encode the URL as:

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

+

Markdown allows you to use these characters naturally, taking +care of 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;
+
+
+

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

+
+AT&T
+
+
+

Markdown will translate it to:

+
+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
+
+
+

Markdown will translate it to:

+
+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 terrible format for writing about HTML +syntax, because every single < and +& in your example code needs to be escaped.)

+
+

Block Elements

+

Paragraphs and Line Breaks

+

A paragraph is simply one or more consecutive lines of text, +separated by one or more blank lines. (A blank line is any line +that looks like a blank line -- a line containing nothing but +spaces or tabs is considered blank.) Normal paragraphs should not +be intended with spaces or tabs.

+

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 character in a paragraph into a +<br /> tag.

+

When you do want to insert a <br /> +break tag using Markdown, you end a line with two or more spaces, +then type return.

+

Yes, this takes a tad more effort to create a <br +/>, but a simplistic "every line break is a <br +/>" rule wouldn't work for Markdown. Markdown's +email-style blockquoting and +multi-paragraph list items 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 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 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 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,
+> 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,
+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 nested blockquote.
+>
+> Back to the first level.
+
+
+

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

+
+> ## This is a header.
+> 
+> 1.   This is the first list item.
+> 2.   This is the second list item.
+> 
+> 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.

+

Lists

+

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

+

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

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

is equivalent to:

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

and:

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

Ordered lists use numbers followed by periods:

+
+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>
+<li>Bird</li>
+<li>McHale</li>
+<li>Parish</li>
+</ol>
+
+
+

If you instead wrote the list in Markdown like this:

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

or even:

+
+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. But if you want to be lazy, you don't have to.

+

If you do use lazy list numbering, however, you should still +start the list with the number 1. At some point in the future, +Markdown may support starting ordered lists at an arbitrary +number.

+

List markers typically start at the left margin, but may be +indented by 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.
+    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.
+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
+*   Magic
+
+
+

will turn into:

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

But this:

+
+*   Bird
+
+*   Magic
+
+
+

will turn into:

+
+<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
+    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.
+
+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 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:
+
+    > 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:
+
+        <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.
+
+
+

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

Code Blocks

+

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 <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 code block.
+
+
+

Markdown will generate:

+
+<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:
+
+    tell application "Foo"
+        beep
+    end tell
+
+
+

will turn into:

+
+<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 >) 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">
+        &copy; 2004 Foo Corporation
+    </div>
+
+
+

will turn into:

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

+

Horizontal Rules

+

You can produce a horizontal rule tag (<hr +/>) by placing three or 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:

+
+* * *
+
+***
+
+*****
+
+- - -
+
+---------------------------------------
+
+_ _ _
+
+
+
+

Span Elements

+ +

Markdown supports two style of links: inline and +reference.

+

In both styles, the link text is delimited by [square +brackets].

+

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 optional title for the link, surrounded in +quotes. For example:

+
+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">
+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.
+
+
+

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

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

+
+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"
+
+
+

That is:

+
    +
  • Square brackets containing the link identifier (optionally +indented from the left margin using up to three spaces);
  • +
  • followed by a colon;
  • +
  • followed by one or more spaces (or tabs);
  • +
  • followed by the URL for the link;
  • +
  • optionally followed by a title attribute for the link, enclosed +in double or single quotes.
  • +
+

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

+
+[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
+    "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]
+
+
+

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][]
+
+
+

And then define the link:

+
+[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.
+
+
+

And then define the link:

+
+[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
+[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
+[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/"
+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")
+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 +reference-style links, the paragraph itself is only 81 characters +long; with inline-style links, it's 176 characters; and as raw +HTML, it's 234 characters. In the raw HTML, there's more markup +than there is text.

+

With Markdown's reference-style links, a source document much +more closely resembles the final output, as rendered in a browser. +By allowing you to move the markup-related metadata out of the +paragraph, you can add links without interrupting the narrative +flow of your prose.

+

Emphasis

+

Markdown treats asterisks (*) and underscores +(_) as indicators of 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 underscores_
+
+**double asterisks**
+
+__double underscores__
+
+
+

will produce:

+
+<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
+
+
+

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\*
+
+
+

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

will produce:

+
+<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.``
+
+
+

which will produce this:

+
+<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 backtick-delimited string in a code span: `` `foo` ``
+
+
+

will produce:

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

into:

+
+<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;`.
+
+
+

to produce:

+
+<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 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 "Optional title")
+
+
+

That is:

+
    +
  • An exclamation mark: !;
  • +
  • followed by a set of square brackets, containing the +alt attribute text for the image;
  • +
  • followed by a set of parentheses, containing the URL or path to +the image, and an optional title attribute enclosed in +double or single quotes.
  • +
+

Reference-style image syntax looks like this:

+
+![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"
+
+
+

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.

+
+

Miscellaneous

+ +

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/>
+
+
+

Markdown will turn this into:

+
+<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>
+
+
+

into something like this:

+
+<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 them. It's better than nothing, but an address published in this +way will probably eventually start receiving spam.)

+

Backslash Escapes

+

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 <em> +tag), you can backslashes before the asterisks, like this:

+
+\*literal asterisks\*
+
+
+

Markdown provides backslash escapes for the following +characters:

+
+\   backslash
+`   backtick
+*   asterisk
+_   underscore
+{}  curly braces
+[]  square brackets
+()  parentheses
+#   hash mark
++   plus sign
+-   minus sign (hyphen)
+.   dot
+!   exclamation mark
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Markdown Documentation - Syntax.text-res b/MarkdownTest/Tests_2004/Markdown Documentation - Syntax.text-res new file mode 100644 index 0000000..ecf2e70 --- /dev/null +++ b/MarkdownTest/Tests_2004/Markdown Documentation - Syntax.text-res @@ -0,0 +1,957 @@ + + + + + + + +

Markdown: Syntax

+ + +

Note: This document is itself written using +Markdown; you can see the +source for it by adding '.text' to the URL.

+
+

Overview

+

Philosophy

+

Markdown is intended to be as easy-to-read and easy-to-write as +is feasible.

+

Readability, however, is emphasized above all else. A +Markdown-formatted 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 +Setext, +atx, Textile, reStructuredText, +Grutatext, and +EtText -- the single +biggest source of inspiration for Markdown's syntax is the format +of plain text email.

+

To this end, Markdown's syntax is comprised entirely of +punctuation characters, which punctuation characters have been +carefully chosen so as to look like what they mean. E.g., asterisks +around a word actually look like *emphasis*. Markdown lists look +like, well, lists. Even blockquotes look like quoted passages of +text, assuming you've ever used email.

+

Inline HTML

+

Markdown's syntax is intended for one purpose: to be used as a +format for writing for the web.

+

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 not 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 publishing format; +Markdown is a writing format. Thus, Markdown's formatting +syntax only addresses issues that can be conveyed in plain +text.

+

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 indicate that you're switching from Markdown to HTML; you just +use the tags.

+

The only restrictions are that block-level HTML elements -- e.g. +<div>, <table>, +<pre>, <p>, 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) +<p> tags around HTML block-level tags.

+

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

+
+This is a regular paragraph.
+
+<table>
+    <tr>
+        <td>Foo</td>
+    </tr>
+</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.

+

Span-level HTML tags -- e.g. <span>, +<cite>, or <del> -- 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 <a> or +<img> tags instead of Markdown's link or image +syntax, go right ahead.

+

Unlike block-level HTML tags, Markdown syntax is +processed within span-level tags.

+

Automatic Escaping for Special Characters

+

In HTML, there are two characters that demand special treatment: +< and &. Left angle brackets are +used to start tags; ampersands are used to denote HTML entities. If +you want to use them as literal characters, you must escape them as +entities, e.g. &lt;, and +&amp;.

+

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
+
+
+

you need to encode the URL as:

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

+

Markdown allows you to use these characters naturally, taking +care of 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;
+
+
+

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

+
+AT&T
+
+
+

Markdown will translate it to:

+
+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
+
+
+

Markdown will translate it to:

+
+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 terrible format for writing about HTML +syntax, because every single < and +& in your example code needs to be escaped.)

+
+

Block Elements

+

Paragraphs and Line Breaks

+

A paragraph is simply one or more consecutive lines of text, +separated by one or more blank lines. (A blank line is any line +that looks like a blank line -- a line containing nothing but +spaces or tabs is considered blank.) Normal paragraphs should not +be intended with spaces or tabs.

+

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 character in a paragraph into a +<br /> tag.

+

When you do want to insert a <br /> +break tag using Markdown, you end a line with two or more spaces, +then type return.

+

Yes, this takes a tad more effort to create a <br +/>, but a simplistic "every line break is a <br +/>" rule wouldn't work for Markdown. Markdown's +email-style blockquoting and +multi-paragraph list items 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 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 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 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,
+> 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,
+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 nested blockquote.
+>
+> Back to the first level.
+
+
+

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

+
+> ## This is a header.
+> 
+> 1.   This is the first list item.
+> 2.   This is the second list item.
+> 
+> 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.

+

Lists

+

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

+

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

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

is equivalent to:

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

and:

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

Ordered lists use numbers followed by periods:

+
+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>
+<li>Bird</li>
+<li>McHale</li>
+<li>Parish</li>
+</ol>
+
+
+

If you instead wrote the list in Markdown like this:

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

or even:

+
+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. But if you want to be lazy, you don't have to.

+

If you do use lazy list numbering, however, you should still +start the list with the number 1. At some point in the future, +Markdown may support starting ordered lists at an arbitrary +number.

+

List markers typically start at the left margin, but may be +indented by 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.
+    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.
+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
+*   Magic
+
+
+

will turn into:

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

But this:

+
+*   Bird
+
+*   Magic
+
+
+

will turn into:

+
+<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
+    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.
+
+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 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:
+
+    > 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:
+
+        <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.
+
+
+

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

Code Blocks

+

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 <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 code block.
+
+
+

Markdown will generate:

+
+<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:
+
+    tell application "Foo"
+        beep
+    end tell
+
+
+

will turn into:

+
+<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 >) 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">
+        &copy; 2004 Foo Corporation
+    </div>
+
+
+

will turn into:

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

+

Horizontal Rules

+

You can produce a horizontal rule tag (<hr +/>) by placing three or 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:

+
+* * *
+
+***
+
+*****
+
+- - -
+
+---------------------------------------
+
+_ _ _
+
+
+
+

Span Elements

+ +

Markdown supports two style of links: inline and +reference.

+

In both styles, the link text is delimited by [square +brackets].

+

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 optional title for the link, surrounded in +quotes. For example:

+
+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">
+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.
+
+
+

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

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

+
+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"
+
+
+

That is:

+
    +
  • Square brackets containing the link identifier (optionally +indented from the left margin using up to three spaces);
  • +
  • followed by a colon;
  • +
  • followed by one or more spaces (or tabs);
  • +
  • followed by the URL for the link;
  • +
  • optionally followed by a title attribute for the link, enclosed +in double or single quotes.
  • +
+

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

+
+[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
+    "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]
+
+
+

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][]
+
+
+

And then define the link:

+
+[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.
+
+
+

And then define the link:

+
+[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
+[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
+[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/"
+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")
+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 +reference-style links, the paragraph itself is only 81 characters +long; with inline-style links, it's 176 characters; and as raw +HTML, it's 234 characters. In the raw HTML, there's more markup +than there is text.

+

With Markdown's reference-style links, a source document much +more closely resembles the final output, as rendered in a browser. +By allowing you to move the markup-related metadata out of the +paragraph, you can add links without interrupting the narrative +flow of your prose.

+

Emphasis

+

Markdown treats asterisks (*) and underscores +(_) as indicators of 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 underscores_
+
+**double asterisks**
+
+__double underscores__
+
+
+

will produce:

+
+<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
+
+
+

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\*
+
+
+

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

will produce:

+
+<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.``
+
+
+

which will produce this:

+
+<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 backtick-delimited string in a code span: `` `foo` ``
+
+
+

will produce:

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

into:

+
+<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;`.
+
+
+

to produce:

+
+<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 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 "Optional title")
+
+
+

That is:

+
    +
  • An exclamation mark: !;
  • +
  • followed by a set of square brackets, containing the +alt attribute text for the image;
  • +
  • followed by a set of parentheses, containing the URL or path to +the image, and an optional title attribute enclosed in +double or single quotes.
  • +
+

Reference-style image syntax looks like this:

+
+![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"
+
+
+

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.

+
+

Miscellaneous

+ +

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/>
+
+
+

Markdown will turn this into:

+
+<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>
+
+
+

into something like this:

+
+<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 them. It's better than nothing, but an address published in this +way will probably eventually start receiving spam.)

+

Backslash Escapes

+

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 <em> +tag), you can backslashes before the asterisks, like this:

+
+\*literal asterisks\*
+
+
+

Markdown provides backslash escapes for the following +characters:

+
+\   backslash
+`   backtick
+*   asterisk
+_   underscore
+{}  curly braces
+[]  square brackets
+()  parentheses
+#   hash mark
++   plus sign
+-   minus sign (hyphen)
+.   dot
+!   exclamation mark
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Nested blockquotes.html b/MarkdownTest/Tests_2004/Nested blockquotes.html new file mode 100644 index 0000000..d8ec7f8 --- /dev/null +++ b/MarkdownTest/Tests_2004/Nested blockquotes.html @@ -0,0 +1,9 @@ +
+

foo

+ +
+

bar

+
+ +

foo

+
diff --git a/MarkdownTest/Tests_2004/Nested blockquotes.text b/MarkdownTest/Tests_2004/Nested blockquotes.text new file mode 100644 index 0000000..ed3c624 --- /dev/null +++ b/MarkdownTest/Tests_2004/Nested blockquotes.text @@ -0,0 +1,5 @@ +> foo +> +> > bar +> +> foo diff --git a/MarkdownTest/Tests_2004/Nested blockquotes.text-out b/MarkdownTest/Tests_2004/Nested blockquotes.text-out new file mode 100644 index 0000000..291201e --- /dev/null +++ b/MarkdownTest/Tests_2004/Nested blockquotes.text-out @@ -0,0 +1,17 @@ + + + + + + + +
+

foo

+
+

bar

+
+

foo

+
+ + diff --git a/MarkdownTest/Tests_2004/Nested blockquotes.text-res b/MarkdownTest/Tests_2004/Nested blockquotes.text-res new file mode 100644 index 0000000..291201e --- /dev/null +++ b/MarkdownTest/Tests_2004/Nested blockquotes.text-res @@ -0,0 +1,17 @@ + + + + + + + +
+

foo

+
+

bar

+
+

foo

+
+ + diff --git a/MarkdownTest/Tests_2004/Ordered and unordered lists.html b/MarkdownTest/Tests_2004/Ordered and unordered lists.html new file mode 100644 index 0000000..ce85c3a --- /dev/null +++ b/MarkdownTest/Tests_2004/Ordered and unordered lists.html @@ -0,0 +1,137 @@ +

Unordered

+ +

Asterisks tight:

+ +
    +
  • asterisk 1
  • +
  • asterisk 2
  • +
  • asterisk 3
  • +
+ +

Asterisks loose:

+ +
    +
  • asterisk 1

  • +
  • asterisk 2

  • +
  • asterisk 3

  • +
+ +
+ +

Pluses tight:

+ +
    +
  • Plus 1
  • +
  • Plus 2
  • +
  • Plus 3
  • +
+ +

Pluses loose:

+ +
    +
  • Plus 1

  • +
  • Plus 2

  • +
  • Plus 3

  • +
+ +
+ +

Minuses tight:

+ +
    +
  • Minus 1
  • +
  • Minus 2
  • +
  • Minus 3
  • +
+ +

Minuses loose:

+ +
    +
  • Minus 1

  • +
  • Minus 2

  • +
  • Minus 3

  • +
+ +

Ordered

+ +

Tight:

+ +
    +
  1. First
  2. +
  3. Second
  4. +
  5. Third
  6. +
+ +

and:

+ +
    +
  1. One
  2. +
  3. Two
  4. +
  5. Three
  6. +
+ +

Loose using tabs:

+ +
    +
  1. First

  2. +
  3. Second

  4. +
  5. Third

  6. +
+ +

and using spaces:

+ +
    +
  1. One

  2. +
  3. Two

  4. +
  5. Three

  6. +
+ +

Multiple paragraphs:

+ +
    +
  1. Item 1, graf one.

    + +

    Item 2. graf two. The quick brown fox jumped over the lazy dog's +back.

  2. +
  3. Item 2.

  4. +
  5. Item 3.

  6. +
+ +

Nested

+ +
    +
  • Tab +
      +
    • Tab +
        +
      • Tab
      • +
    • +
  • +
+ +

Here's another:

+ +
    +
  1. First
  2. +
  3. Second: +
      +
    • Fee
    • +
    • Fie
    • +
    • Foe
    • +
  4. +
  5. Third
  6. +
+ +

Same thing but with paragraphs:

+ +
    +
  1. First

  2. +
  3. Second:

    + +
      +
    • Fee
    • +
    • Fie
    • +
    • Foe
    • +
  4. +
  5. Third

  6. +
diff --git a/MarkdownTest/Tests_2004/Ordered and unordered lists.text b/MarkdownTest/Tests_2004/Ordered and unordered lists.text new file mode 100644 index 0000000..621db58 --- /dev/null +++ b/MarkdownTest/Tests_2004/Ordered and unordered lists.text @@ -0,0 +1,122 @@ +## Unordered + +Asterisks tight: + +* asterisk 1 +* asterisk 2 +* asterisk 3 + + +Asterisks loose: + +* asterisk 1 + +* asterisk 2 + +* asterisk 3 + +* * * + +Pluses tight: + ++ Plus 1 ++ Plus 2 ++ Plus 3 + + +Pluses loose: + ++ Plus 1 + ++ Plus 2 + ++ Plus 3 + +* * * + + +Minuses tight: + +- Minus 1 +- Minus 2 +- Minus 3 + + +Minuses loose: + +- Minus 1 + +- Minus 2 + +- Minus 3 + + +## Ordered + +Tight: + +1. First +2. Second +3. Third + +and: + +1. One +2. Two +3. Three + + +Loose using tabs: + +1. First + +2. Second + +3. Third + +and using spaces: + +1. One + +2. Two + +3. Three + +Multiple paragraphs: + +1. Item 1, graf one. + + Item 2. graf two. The quick brown fox jumped over the lazy dog's + back. + +2. Item 2. + +3. Item 3. + + + +## Nested + +* Tab + * Tab + * Tab + +Here's another: + +1. First +2. Second: + * Fee + * Fie + * Foe +3. Third + +Same thing but with paragraphs: + +1. First + +2. Second: + * Fee + * Fie + * Foe + +3. Third diff --git a/MarkdownTest/Tests_2004/Ordered and unordered lists.text-out b/MarkdownTest/Tests_2004/Ordered and unordered lists.text-out new file mode 100644 index 0000000..5e19e71 --- /dev/null +++ b/MarkdownTest/Tests_2004/Ordered and unordered lists.text-out @@ -0,0 +1,159 @@ + + + + + + + +

Unordered

+

Asterisks tight:

+
    +
  • asterisk 1
  • +
  • asterisk 2
  • +
  • asterisk 3
  • +
+

Asterisks loose:

+
    +
  • +

    asterisk 1

    +
  • +
  • +

    asterisk 2

    +
  • +
  • +

    asterisk 3

    +
  • +
+
+

Pluses tight:

+
    +
  • Plus 1
  • +
  • Plus 2
  • +
  • Plus 3
  • +
+

Pluses loose:

+
    +
  • +

    Plus 1

    +
  • +
  • +

    Plus 2

    +
  • +
  • +

    Plus 3

    +
  • +
+
+

Minuses tight:

+
    +
  • Minus 1
  • +
  • Minus 2
  • +
  • Minus 3
  • +
+

Minuses loose:

+
    +
  • +

    Minus 1

    +
  • +
  • +

    Minus 2

    +
  • +
  • +

    Minus 3

    +
  • +
+

Ordered

+

Tight:

+
    +
  1. First
  2. +
  3. Second
  4. +
  5. Third
  6. +
+

and:

+
    +
  1. One
  2. +
  3. Two
  4. +
  5. Three
  6. +
+

Loose using tabs:

+
    +
  1. +

    First

    +
  2. +
  3. +

    Second

    +
  4. +
  5. +

    Third

    +
  6. +
+

and using spaces:

+
    +
  1. +

    One

    +
  2. +
  3. +

    Two

    +
  4. +
  5. +

    Three

    +
  6. +
+

Multiple paragraphs:

+
    +
  1. +

    Item 1, graf one.

    +

    Item 2. graf two. The quick brown fox jumped over the lazy dog's +back.

    +
  2. +
  3. +

    Item 2.

    +
  4. +
  5. +

    Item 3.

    +
  6. +
+

Nested

+
    +
  • Tab +
      +
    • Tab +
        +
      • Tab
      • +
      +
    • +
    +
  • +
+

Here's another:

+
    +
  1. First
  2. +
  3. Second: +
      +
    • Fee
    • +
    • Fie
    • +
    • Foe
    • +
    +
  4. +
  5. Third
  6. +
+

Same thing but with paragraphs:

+
    +
  1. +

    First

    +
  2. +
  3. +

    Second:

    +
      +
    • Fee
    • +
    • Fie
    • +
    • Foe
    • +
    +
  4. +
  5. +

    Third

    +
  6. +
+ + diff --git a/MarkdownTest/Tests_2004/Ordered and unordered lists.text-res b/MarkdownTest/Tests_2004/Ordered and unordered lists.text-res new file mode 100644 index 0000000..5e19e71 --- /dev/null +++ b/MarkdownTest/Tests_2004/Ordered and unordered lists.text-res @@ -0,0 +1,159 @@ + + + + + + + +

Unordered

+

Asterisks tight:

+
    +
  • asterisk 1
  • +
  • asterisk 2
  • +
  • asterisk 3
  • +
+

Asterisks loose:

+
    +
  • +

    asterisk 1

    +
  • +
  • +

    asterisk 2

    +
  • +
  • +

    asterisk 3

    +
  • +
+
+

Pluses tight:

+
    +
  • Plus 1
  • +
  • Plus 2
  • +
  • Plus 3
  • +
+

Pluses loose:

+
    +
  • +

    Plus 1

    +
  • +
  • +

    Plus 2

    +
  • +
  • +

    Plus 3

    +
  • +
+
+

Minuses tight:

+
    +
  • Minus 1
  • +
  • Minus 2
  • +
  • Minus 3
  • +
+

Minuses loose:

+
    +
  • +

    Minus 1

    +
  • +
  • +

    Minus 2

    +
  • +
  • +

    Minus 3

    +
  • +
+

Ordered

+

Tight:

+
    +
  1. First
  2. +
  3. Second
  4. +
  5. Third
  6. +
+

and:

+
    +
  1. One
  2. +
  3. Two
  4. +
  5. Three
  6. +
+

Loose using tabs:

+
    +
  1. +

    First

    +
  2. +
  3. +

    Second

    +
  4. +
  5. +

    Third

    +
  6. +
+

and using spaces:

+
    +
  1. +

    One

    +
  2. +
  3. +

    Two

    +
  4. +
  5. +

    Three

    +
  6. +
+

Multiple paragraphs:

+
    +
  1. +

    Item 1, graf one.

    +

    Item 2. graf two. The quick brown fox jumped over the lazy dog's +back.

    +
  2. +
  3. +

    Item 2.

    +
  4. +
  5. +

    Item 3.

    +
  6. +
+

Nested

+
    +
  • Tab +
      +
    • Tab +
        +
      • Tab
      • +
      +
    • +
    +
  • +
+

Here's another:

+
    +
  1. First
  2. +
  3. Second: +
      +
    • Fee
    • +
    • Fie
    • +
    • Foe
    • +
    +
  4. +
  5. Third
  6. +
+

Same thing but with paragraphs:

+
    +
  1. +

    First

    +
  2. +
  3. +

    Second:

    +
      +
    • Fee
    • +
    • Fie
    • +
    • Foe
    • +
    +
  4. +
  5. +

    Third

    +
  6. +
+ + diff --git a/MarkdownTest/Tests_2004/Strong and em together.html b/MarkdownTest/Tests_2004/Strong and em together.html new file mode 100644 index 0000000..71ec78c --- /dev/null +++ b/MarkdownTest/Tests_2004/Strong and em together.html @@ -0,0 +1,7 @@ +

This is strong and em.

+ +

So is this word.

+ +

This is strong and em.

+ +

So is this word.

diff --git a/MarkdownTest/Tests_2004/Strong and em together.text b/MarkdownTest/Tests_2004/Strong and em together.text new file mode 100644 index 0000000..95ee690 --- /dev/null +++ b/MarkdownTest/Tests_2004/Strong and em together.text @@ -0,0 +1,7 @@ +***This is strong and em.*** + +So is ***this*** word. + +___This is strong and em.___ + +So is ___this___ word. diff --git a/MarkdownTest/Tests_2004/Strong and em together.text-out b/MarkdownTest/Tests_2004/Strong and em together.text-out new file mode 100644 index 0000000..b596c19 --- /dev/null +++ b/MarkdownTest/Tests_2004/Strong and em together.text-out @@ -0,0 +1,14 @@ + + + + + + + +

This is strong and em.

+

So is this word.

+

This is strong and em.

+

So is this word.

+ + diff --git a/MarkdownTest/Tests_2004/Strong and em together.text-res b/MarkdownTest/Tests_2004/Strong and em together.text-res new file mode 100644 index 0000000..b596c19 --- /dev/null +++ b/MarkdownTest/Tests_2004/Strong and em together.text-res @@ -0,0 +1,14 @@ + + + + + + + +

This is strong and em.

+

So is this word.

+

This is strong and em.

+

So is this word.

+ + diff --git a/MarkdownTest/Tests_2004/Tabs.html b/MarkdownTest/Tests_2004/Tabs.html new file mode 100644 index 0000000..3301ba8 --- /dev/null +++ b/MarkdownTest/Tests_2004/Tabs.html @@ -0,0 +1,25 @@ +
    +
  • this is a list item +indented with tabs

  • +
  • this is a list item +indented with spaces

  • +
+ +

Code:

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

And:

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

And:

+ +
+   this is an example list item
+    indented with tabs
+
++   this is an example list item
+    indented with spaces
+
diff --git a/MarkdownTest/Tests_2004/Tabs.text b/MarkdownTest/Tests_2004/Tabs.text new file mode 100644 index 0000000..589d113 --- /dev/null +++ b/MarkdownTest/Tests_2004/Tabs.text @@ -0,0 +1,21 @@ ++ this is a list item + indented with tabs + ++ this is a list item + indented with spaces + +Code: + + this code block is indented by one tab + +And: + + this code block is indented by two tabs + +And: + + + this is an example list item + indented with tabs + + + this is an example list item + indented with spaces diff --git a/MarkdownTest/Tests_2004/Tabs.text-out b/MarkdownTest/Tests_2004/Tabs.text-out new file mode 100644 index 0000000..0cd92b1 --- /dev/null +++ b/MarkdownTest/Tests_2004/Tabs.text-out @@ -0,0 +1,37 @@ + + + + + + + +
    +
  • +

    this is a list item indented with tabs

    +
  • +
  • +

    this is a list item indented with spaces

    +
  • +
+

Code:

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

And:

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

And:

+
++   this is an example list item
+    indented with tabs
+
++   this is an example list item
+    indented with spaces
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Tabs.text-res b/MarkdownTest/Tests_2004/Tabs.text-res new file mode 100644 index 0000000..0cd92b1 --- /dev/null +++ b/MarkdownTest/Tests_2004/Tabs.text-res @@ -0,0 +1,37 @@ + + + + + + + +
    +
  • +

    this is a list item indented with tabs

    +
  • +
  • +

    this is a list item indented with spaces

    +
  • +
+

Code:

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

And:

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

And:

+
++   this is an example list item
+    indented with tabs
+
++   this is an example list item
+    indented with spaces
+
+
+ + diff --git a/MarkdownTest/Tests_2004/Tidyness.html b/MarkdownTest/Tests_2004/Tidyness.html new file mode 100644 index 0000000..f2a8ce7 --- /dev/null +++ b/MarkdownTest/Tests_2004/Tidyness.html @@ -0,0 +1,8 @@ +
+

A list within a blockquote:

+
    +
  • asterisk 1
  • +
  • asterisk 2
  • +
  • asterisk 3
  • +
+
diff --git a/MarkdownTest/Tests_2004/Tidyness.text b/MarkdownTest/Tests_2004/Tidyness.text new file mode 100644 index 0000000..5f18b8d --- /dev/null +++ b/MarkdownTest/Tests_2004/Tidyness.text @@ -0,0 +1,5 @@ +> A list within a blockquote: +> +> * asterisk 1 +> * asterisk 2 +> * asterisk 3 diff --git a/MarkdownTest/Tests_2004/Tidyness.text-out b/MarkdownTest/Tests_2004/Tidyness.text-out new file mode 100644 index 0000000..ebae4c4 --- /dev/null +++ b/MarkdownTest/Tests_2004/Tidyness.text-out @@ -0,0 +1,18 @@ + + + + + + + +
+

A list within a blockquote:

+
    +
  • asterisk 1
  • +
  • asterisk 2
  • +
  • asterisk 3
  • +
+
+ + diff --git a/MarkdownTest/Tests_2004/Tidyness.text-res b/MarkdownTest/Tests_2004/Tidyness.text-res new file mode 100644 index 0000000..ebae4c4 --- /dev/null +++ b/MarkdownTest/Tests_2004/Tidyness.text-res @@ -0,0 +1,18 @@ + + + + + + + +
+

A list within a blockquote:

+
    +
  • asterisk 1
  • +
  • asterisk 2
  • +
  • asterisk 3
  • +
+
+ + diff --git a/MarkdownTest/Tests_2004/Yuri-Attributes.html b/MarkdownTest/Tests_2004/Yuri-Attributes.html new file mode 100644 index 0000000..057da2f --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Attributes.html @@ -0,0 +1,28 @@ + + +

Lorem ipsum

+

Dolor sit amet, consectetur adipisicing 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 pariatur2. Excepteur sint occaecat + cupidatat non proident, sunt in culpa qui officia deserunt mollit + anim id est laborum. +

    + +
  • +
+

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

+ + diff --git a/MarkdownTest/Tests_2004/Yuri-Attributes.text b/MarkdownTest/Tests_2004/Yuri-Attributes.text new file mode 100644 index 0000000..8ee512d --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Attributes.text @@ -0,0 +1,19 @@ + +Lorem ipsum {@id=lorem} +================================= + +Dolor sit amet, consectetur adipisicing 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.{@class=first_item} + +* Duis aute irure dolor in reprehenderit in voluptate velit esse + cillum dolore eu fugiat nulla pariatur2. Excepteur sint occaecat + cupidatat non proident, sunt in culpa qui officia deserunt mollit + anim id est laborum. + +Duis aute **irure{@type=term}** 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. diff --git a/MarkdownTest/Tests_2004/Yuri-Attributes.text-out b/MarkdownTest/Tests_2004/Yuri-Attributes.text-out new file mode 100644 index 0000000..38fd233 --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Attributes.text-out @@ -0,0 +1,29 @@ + + + + + + +

Lorem ipsum

+

Dolor sit amet, consectetur adipisicing 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 pariatur2. Excepteur sint occaecat +cupidatat non proident, sunt in culpa qui officia deserunt mollit +anim id est laborum.

    +
  • +
+

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.

+ + diff --git a/MarkdownTest/Tests_2004/Yuri-Attributes.text-res b/MarkdownTest/Tests_2004/Yuri-Attributes.text-res new file mode 100644 index 0000000..38fd233 --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Attributes.text-res @@ -0,0 +1,29 @@ + + + + + + +

Lorem ipsum

+

Dolor sit amet, consectetur adipisicing 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 pariatur2. Excepteur sint occaecat +cupidatat non proident, sunt in culpa qui officia deserunt mollit +anim id est laborum.

    +
  • +
+

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.

+ + diff --git a/MarkdownTest/Tests_2004/Yuri-Attributes.text~ b/MarkdownTest/Tests_2004/Yuri-Attributes.text~ new file mode 100644 index 0000000..ba8fecd --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Attributes.text~ @@ -0,0 +1,24 @@ + +Lorem ipsum {@id=lorem} +================================= + +Dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor +incididunt ut labore et dolore magna aliqua1. 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 pariatur2. Excepteur sint +occaecat cupidatat non proident, sunt in culpa qui officia deserunt +mollit anim id est laborum. + + + + * Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore3 magna aliqua. + +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. + + 1. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.%G↩%@ + 2. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. + + Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. %G↩%@ + 3. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. %G↩%@ + diff --git a/MarkdownTest/Tests_2004/Yuri-Email.html b/MarkdownTest/Tests_2004/Yuri-Email.html new file mode 100644 index 0000000..bf1d149 --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Email.html @@ -0,0 +1,18 @@ + +

Lorem ipsum yuri@domain.org, etc. +

+
    +
  • + An email address in a list +
  • + +
  • + yuri@domain.org +
  • + +
  • + Another item. +
  • +
+ + diff --git a/MarkdownTest/Tests_2004/Yuri-Email.text b/MarkdownTest/Tests_2004/Yuri-Email.text new file mode 100644 index 0000000..8f9c779 --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Email.text @@ -0,0 +1,7 @@ +Lorem ipsum , etc. + +* An email address in a list +* +* Another item. + + diff --git a/MarkdownTest/Tests_2004/Yuri-Email.text-out b/MarkdownTest/Tests_2004/Yuri-Email.text-out new file mode 100644 index 0000000..2fc9c74 --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Email.text-out @@ -0,0 +1,17 @@ + + + + + + + +

Lorem ipsum yuri@domain.org, etc.

+ + + diff --git a/MarkdownTest/Tests_2004/Yuri-Email.text-res b/MarkdownTest/Tests_2004/Yuri-Email.text-res new file mode 100644 index 0000000..2fc9c74 --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Email.text-res @@ -0,0 +1,17 @@ + + + + + + + +

Lorem ipsum yuri@domain.org, etc.

+ + + diff --git a/MarkdownTest/Tests_2004/Yuri-Footnotes.html b/MarkdownTest/Tests_2004/Yuri-Footnotes.html new file mode 100644 index 0000000..cadb040 --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Footnotes.html @@ -0,0 +1,46 @@ + +

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua1. 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 pariatur2. Excepteur sint + occaecat cupidatat non proident, sunt in culpa qui officia deserunt + mollit anim id est laborum. +

+
    +
  • + Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do + eiusmod tempor incididunt ut labore et dolore3 magna aliqua. +
  • +
+

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

+ +

    +
  1. + Sed ut perspiciatis unde omnis iste natus error sit voluptatem + accusantium doloremque laudantium, totam rem aperiam, eaque ipsa + quae ab illo inventore veritatis et quasi architecto beatae vitae + dicta sunt explicabo. +
  2. + +
  3. + Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit + aut fugit, sed quia consequuntur magni dolores eos qui ratione + voluptatem sequi nesciunt.

    Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, + consectetur, adipisci velit, sed quia non numquam eius modi + tempora incidunt ut labore et dolore magnam aliquam quaerat + voluptatem. +

    + +
  4. + +
  5. + Ut enim ad minim veniam, quis nostrud exercitation ullamco + laboris nisi ut aliquip ex ea commodo consequat. +
  6. +
+
diff --git a/MarkdownTest/Tests_2004/Yuri-Footnotes.text b/MarkdownTest/Tests_2004/Yuri-Footnotes.text new file mode 100644 index 0000000..16fe402 --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Footnotes.text @@ -0,0 +1,32 @@ +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod +tempor incididunt ut labore et dolore magna aliqua[^2]. 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[^1]. Excepteur sint +occaecat cupidatat non proident, sunt in culpa qui officia deserunt +mollit anim id est laborum. + +[^1]: Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit + aut fugit, sed quia consequuntur magni dolores eos qui ratione + voluptatem sequi nesciunt. + + Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, + consectetur, adipisci velit, sed quia non numquam eius modi + tempora incidunt ut labore et dolore magnam aliquam quaerat + voluptatem. + +[^2]: Sed ut perspiciatis unde omnis iste natus error sit voluptatem + accusantium doloremque laudantium, totam rem aperiam, eaque ipsa + quae ab illo inventore veritatis et quasi architecto beatae vitae + dicta sunt explicabo. + +* Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do + eiusmod tempor incididunt ut labore et dolore[^foo] magna aliqua. + +[^foo]: 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. diff --git a/MarkdownTest/Tests_2004/Yuri-Footnotes.text-out b/MarkdownTest/Tests_2004/Yuri-Footnotes.text-out new file mode 100644 index 0000000..b934c10 --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Footnotes.text-out @@ -0,0 +1,42 @@ + + + + + + + +

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do +eiusmod tempor incididunt ut labore et dolore magna aliqua[^2]. 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[^1]. Excepteur sint occaecat cupidatat non proident, sunt +in culpa qui officia deserunt mollit anim id est laborum.

+

[^1]: Nemo enim ipsam voluptatem quia voluptas sit aspernatur +aut odit aut fugit, sed quia consequuntur magni dolores eos qui +ratione voluptatem sequi nesciunt.

+
+  Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, 
+  consectetur, adipisci velit, sed quia non numquam eius modi 
+  tempora incidunt ut labore et dolore magnam aliquam quaerat 
+  voluptatem.
+
+
+

[^2]: Sed ut perspiciatis unde omnis iste natus error sit +voluptatem accusantium doloremque laudantium, totam rem aperiam, +eaque ipsa quae ab illo inventore veritatis et quasi architecto +beatae vitae dicta sunt explicabo.

+
    +
  • Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed +do eiusmod tempor incididunt ut labore et dolore[^foo] magna +aliqua.
  • +
+

[^foo]: 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.

+ + diff --git a/MarkdownTest/Tests_2004/Yuri-Footnotes.text-res b/MarkdownTest/Tests_2004/Yuri-Footnotes.text-res new file mode 100644 index 0000000..5752e27 --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Footnotes.text-res @@ -0,0 +1,55 @@ + + + + + + + +

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do +eiusmod tempor incididunt ut labore et dolore magna +aliqua1. 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 pariatur2. Excepteur sint occaecat cupidatat non +proident, sunt in culpa qui officia deserunt mollit anim id est +laborum.

+
    +
  • Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed +do eiusmod tempor incididunt ut labore et dolore3 magna aliqua.
  • +
+

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.

+
+
+
    +
  1. Sed ut perspiciatis unde omnis iste natus +error sit voluptatem accusantium doloremque laudantium, totam rem +aperiam, eaque ipsa quae ab illo inventore veritatis et quasi +architecto beatae vitae dicta sunt explicabo.
  2. +
  3. Nemo enim ipsam voluptatem quia voluptas sit +aspernatur aut odit aut fugit, sed quia consequuntur magni dolores +eos qui ratione voluptatem sequi nesciunt. +

    Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, +consectetur, adipisci velit, sed quia non numquam eius modi tempora +incidunt ut labore et dolore magnam aliquam quaerat voluptatem. +

    +
  4. +
  5. Ut enim ad minim veniam, quis nostrud +exercitation ullamco laboris nisi ut aliquip ex ea commodo +consequat.
  6. +
+
+ + diff --git a/MarkdownTest/Tests_2004/Yuri-Links-in-Headers.html b/MarkdownTest/Tests_2004/Yuri-Links-in-Headers.html new file mode 100644 index 0000000..6afc56e --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Links-in-Headers.html @@ -0,0 +1,15 @@ +

A plain header

+ +

Let's first have a plain header

+ +

An underlined header

+ +

(That's also useful)

+ +

A header with a link

+ +

First with a hash

+ +

Another with a link

+ +

This time underlined

diff --git a/MarkdownTest/Tests_2004/Yuri-Links-in-Headers.text b/MarkdownTest/Tests_2004/Yuri-Links-in-Headers.text new file mode 100644 index 0000000..d06a9e1 --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Links-in-Headers.text @@ -0,0 +1,18 @@ +## A plain header + +Let's first have a plain header + +An underlined header +==================== + +(That's also useful) + +# A header with a [link](http://www.link.com) + +First with a hash + +Another with a [link][a] +------------------------ +This time underlined + +[a]: http://www.link.com/ diff --git a/MarkdownTest/Tests_2004/Yuri-Links-in-Headers.text-out b/MarkdownTest/Tests_2004/Yuri-Links-in-Headers.text-out new file mode 100644 index 0000000..1c5cf77 --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Links-in-Headers.text-out @@ -0,0 +1,18 @@ + + + + + + + +

A plain header

+

Let's first have a plain header

+

An underlined header

+

(That's also useful)

+

A header with a link

+

First with a hash

+

Another with a link

+

This time underlined

+ + diff --git a/MarkdownTest/Tests_2004/Yuri-Links-in-Headers.text-res b/MarkdownTest/Tests_2004/Yuri-Links-in-Headers.text-res new file mode 100644 index 0000000..1c5cf77 --- /dev/null +++ b/MarkdownTest/Tests_2004/Yuri-Links-in-Headers.text-res @@ -0,0 +1,18 @@ + + + + + + + +

A plain header

+

Let's first have a plain header

+

An underlined header

+

(That's also useful)

+

A header with a link

+

First with a hash

+

Another with a link

+

This time underlined

+ + diff --git a/MarkdownTest/readme.txt b/MarkdownTest/readme.txt new file mode 100644 index 0000000..68047b5 --- /dev/null +++ b/MarkdownTest/readme.txt @@ -0,0 +1 @@ +MarkdownTest_1.0_2007-05-09 updated for the new version of tidy. -- cgit v1.2.3