Skip to content

Commit ae19014

Browse files
author
esskar
committed
reformat README.md
1 parent 2adb2aa commit ae19014

File tree

1 file changed

+71
-58
lines changed

1 file changed

+71
-58
lines changed

‎README.md

+71-58
Original file line numberDiff line numberDiff line change
@@ -2,83 +2,96 @@
22

33
Open source C# implementation of Markdown processor, as featured on Stack Overflow.
44

5-
This port is based heavily on the original Perl 1.0.1 and Perl 1.0.2b8 implementations of Markdown, with bits and pieces of the apparently much better maintained PHP Markdown folded into it. There are a few Stack Overflow specific modifications (which are all configurable, and all off by default). I'd like to ensure that this version stays within shouting distance of the Markdown "specification", such as it is...
5+
This port is based heavily on the original Perl 1.0.1 and Perl 1.0.2b8 implementations of
6+
Markdown, with bits and pieces of the apparently much better maintained PHP Markdown folded
7+
into it. There are a few Stack Overflow specific modifications (which are all configurable,
8+
and all off by default). I'd like to ensure that this version stays within shouting distance
9+
of the Markdown "specification", such as it is...
610

711
## Please contribute!
812
You'll need to know:
913

1014
* C#
11-
* Regular Expressions (I mean really freaking know them -- the original Markdown implementation was in Perl. Consider yourselves warned.)
15+
* Regular Expressions (I mean really freaking know them -- the original Markdown implementation
16+
was in Perl. Consider yourselves warned.)
1217
* Markdown
13-
* If you'd like to contribute file issues and attach *.patch files of proposed fixes. Beyond that, we'll see, but I do plan to open it up over time to trusted contributors.
18+
* If you'd like to contribute file issues and attach *.patch files of proposed fixes. Beyond that,
19+
we'll see, but I do plan to open it up over time to trusted contributors.
1420

15-
Please note that as of January 8, 2011 MarkdownSharp uses Mercurial for version control; the old Subversion repository will not be updated anymore.
21+
Please note that as of January 8, 2011 MarkdownSharp uses Mercurial for version control; the old
22+
Subversion repository will not be updated anymore.
1623

1724
## Tests
1825
I pulled in the MDTest 1.1 test suite, along with some very rudimentary unit tests of my own. Results of Test(@"mdtest-1.1"):
1926

2027
## MarkdownSharp v1.12 test run on \mdtest-1.1
2128

22-
001 Amps_and_angle_encoding OK
23-
002 Auto_links OK
24-
003 Backslash_escapes OK^
25-
004 Blockquotes_with_code_blocks OK
26-
005 Code_Blocks OK
27-
006 Code_Spans OK
28-
007 Hard_wrapped_paragraphs_with_list_like_lines OK
29-
008 Horizontal_rules OK
30-
009 Images OK
31-
010 Inline_HTML_Advanced OK
32-
011 Inline_HTML_comments OK
33-
012 Inline_HTML_Simple OK
34-
013 Links_inline_style OK
35-
014 Links_reference_style OK
36-
015 Links_shortcut_references OK
37-
016 Literal_quotes_in_titles OK
38-
017 Markdown_Documentation_Basics OK
39-
018 Markdown_Documentation_Syntax OK
40-
019 Nested_blockquotes OK
41-
020 Ordered_and_unordered_lists OK^
42-
021 Strong_and_em_together OK
43-
022 Tabs OK
44-
023 Tidyness OK^
29+
001 Amps_and_angle_encoding OK
30+
002 Auto_links OK
31+
003 Backslash_escapes OK^
32+
004 Blockquotes_with_code_blocks OK
33+
005 Code_Blocks OK
34+
006 Code_Spans OK
35+
007 Hard_wrapped_paragraphs_with_list_like_lines OK
36+
008 Horizontal_rules OK
37+
009 Images OK
38+
010 Inline_HTML_Advanced OK
39+
011 Inline_HTML_comments OK
40+
012 Inline_HTML_Simple OK
41+
013 Links_inline_style OK
42+
014 Links_reference_style OK
43+
015 Links_shortcut_references OK
44+
016 Literal_quotes_in_titles OK
45+
017 Markdown_Documentation_Basics OK
46+
018 Markdown_Documentation_Syntax OK
47+
019 Nested_blockquotes OK
48+
020 Ordered_and_unordered_lists OK^
49+
021 Strong_and_em_together OK
50+
022 Tabs OK
51+
023 Tidyness OK^
4552

46-
Tests : 23
47-
OK : 23 (^ 3 whitespace differences)
48-
Mismatch : 0
49-
The original C# port is included as MarkdownOld for comparison. There were some port-specific bugs, but most of the bugs were inherited from the original circa-2004 Markdown.pl (v1.0.1) the library was based on. I've been pulling across some fixes from a newer circa-2007 Markdown.pl (v.1.0.2b8). I have included both of these in the \source\perl folder so it's easier to compare them to their C# counterparts.
53+
Tests : 23
54+
OK : 23 (^ 3 whitespace differences)
55+
Mismatch : 0
5056

51-
To see what's wrong, diff the *.html and *.actual.html files generated from Test(@"mdtest-1.1"). (Note that these files are only generated if the actual output is different from the expected output.) Feel free to open issues anything in particular that you feel should be worked on first, based on existing bug reports.
57+
The original C# port is included as MarkdownOld for comparison. There were some port-specific bugs, but
58+
most of the bugs were inherited from the original circa-2004 Markdown.pl (v1.0.1) the library was based
59+
on. I've been pulling across some fixes from a newer circa-2007 Markdown.pl (v.1.0.2b8). I have included
60+
both of these in the \source\perl folder so it's easier to compare them to their C# counterparts.
61+
62+
To see what's wrong, diff the *.html and *.actual.html files generated from Test(@"mdtest-1.1"). (Note
63+
that these files are only generated if the actual output is different from the expected output.) Feel free
64+
to open issues anything in particular that you feel should be worked on first, based on existing bug reports.
5265

5366
## Benchmarks
5467
This version is many times faster than the original. The built-in Benchmark() routine is provided for benchmarking.
5568

56-
## Markdown.NET
69+
### Markdown.NET
5770

58-
input string length: 475
59-
4000 iterations in 18843 ms (4.71075 ms per iteration)
60-
input string length: 2356
61-
1000 iterations in 8992 ms (8.992 ms per iteration)
62-
input string length: 27737
63-
100 iterations in 15016 ms (150.16 ms per iteration)
64-
input string length: 11075
65-
1 iteration in 55 ms
66-
input string length: 88607
67-
1 iteration in 672 ms
68-
input string length: 354431
69-
1 iteration in 6375 ms
71+
input string length: 475
72+
4000 iterations in 18843 ms (4.71075 ms per iteration)
73+
input string length: 2356
74+
1000 iterations in 8992 ms (8.992 ms per iteration)
75+
input string length: 27737
76+
100 iterations in 15016 ms (150.16 ms per iteration)
77+
input string length: 11075
78+
1 iteration in 55 ms
79+
input string length: 88607
80+
1 iteration in 672 ms
81+
input string length: 354431
82+
1 iteration in 6375 ms
7083

71-
## MarkdownSharp v1.12
84+
### MarkdownSharp v1.12
7285

73-
input string length: 475
74-
4000 iterations in 1778 ms (0.4445 ms per iteration)
75-
input string length: 2356
76-
1000 iterations in 1791 ms (1.791 ms per iteration)
77-
input string length: 27737
78-
100 iterations in 1932 ms (19.32 ms per iteration)
79-
input string length: 11075
80-
1 iteration in 10 ms
81-
input string length: 88607
82-
1 iteration in 74 ms
83-
input string length: 354431
84-
1 iteration in 306 ms
86+
input string length: 475
87+
4000 iterations in 1778 ms (0.4445 ms per iteration)
88+
input string length: 2356
89+
1000 iterations in 1791 ms (1.791 ms per iteration)
90+
input string length: 27737
91+
100 iterations in 1932 ms (19.32 ms per iteration)
92+
input string length: 11075
93+
1 iteration in 10 ms
94+
input string length: 88607
95+
1 iteration in 74 ms
96+
input string length: 354431
97+
1 iteration in 306 ms

0 commit comments

Comments
 (0)