txtmark - Java markdown processor

Copyright (C) 2011 René Jeschke rene_jeschke@yahoo.de
See LICENSE.txt for licensing information.

---

txtmark is yet another markdown processor for the JVM.
... and is damn fast^^

Again this is a WIP release.

TODO:

• block-level HTML element processing
• code clean-ups
• see below (markdown test suite)

MarkdownTest results so far

---

Based on MarkdownTest_1.0_2007-05-09

• Amps and angle encoding ... OK
• Auto links ... OK
• Backslash escapes ... OK
• Blockquotes with code blocks ... OK
• Code Blocks ... OK
• Code Spans ... OK
• Hard-wrapped paragraphs with list-like lines ... OK
• Horizontal rules ... OK
• Images ... FAILED (see Note 1)
• Inline HTML (Advanced) ... FAILED (see Note 2)
• Inline HTML (Simple) ... FAILED (see Note 2)
• Inline HTML comments ... FAILED (see Note 2)
• Links, inline style ... OK
• Links, reference style ... OK
• Links, shortcut references ... OK
• Literal quotes in titles ... FAILED (see Note 3)
• Markdown Documentation - Basics ... OK
• Markdown Documentation - Syntax ... FAILED (see Note 2)
• Nested blockquotes ... OK
• Ordered and unordered lists ... OK
• Strong and em together ... OK
• Tabs ... OK
• Tidyness ... OK

17 passed; 6 failed.

---

1. Note:

   Fails because Txtmark doesn't produce empty 'title' image attributes. (IMHO: Images ... OK)

2. Note:

   Fails because of currently missing block-level HTML identification.

3. Note:

   What the frell ... this test will continue to FAIL. Sorry, but using unescaped `"` in a title which should be surrounded by `"` is unacceptable for me ;)

   Change:

    Foo [bar](/url/ "Title with "quotes" inside").
    [bar]: /url/ "Title with "quotes" inside"
   

   to:

    Foo [bar](/url/ "Title with \"quotes\" inside").
    [bar]: /url/ "Title with \"quotes\" inside"
   

   and Txtmark will produce the correct result.
   (IMHO: Literal quotes in titles ... OK)

Performance comparison of markdown processors for the JVM

---

Based on this.
Txtmark's results should not be considered final, they may change in either direction during the upcoming releases.
But I think you get the point.

Test	Actuarius		PegDown		Knockoff		Txtmark
	1st Run (ms)	2nd Run (ms)	1st Run (ms)	2nd Run (ms)	1st Run (ms)	2nd Run (ms)	1st Run (ms)	2nd Run (ms)
Plain Paragraphs	969	300	1468	956	564	362	114	45
Every Word Emphasized	1409	884	1435	1417	13161	12921	52	44
Every Word Strong	1087	978	1125	1100	9717	9586	40	46
Every Word Inline Code	351	278	1047	1037	9499	9245	45	35
Every Word a Fast Link	2123	1580	523	512	4086	3470	78	50
Every Word Consisting of Special XML Chars	3981	3973	3341	3055	372	319	1842	1841
Every Word wrapped in manual HTML tags	3073	2907	901	888	3826	3529	492	453
Every Line with a manual line break	437	583	1370	1363	1352	957	42	44
Every word with a full link	398	266	1057	1014	1755	1689	88	47
Every word with a full image	228	139	1110	1101	1917	1773	37	33
Every word with a reference link	9726	9146	19019	20044	117632	118306	1431	1240
Every block a quote	431	205	1366	1328	474	464	35	36
Every block a codeblock	68	84	387	377	161	169	61	19
Every block a list	863	912	1735	1762	602	686	46	36
All tests together	3319	2959	5245	5305	10252	9751	222	173

[Actuarius] version: 0.2
[PegDown] version: 0.8.5.4
[Knockoff] version: 0.7.3-15

---

[Markdown] is copyright (c) 2004 by John Gruber
[Markdown]: http://daringfireball.net/projects/markdown/ [Actuarius] is copyright (c) 2010 by Christoph Henkelmann
[Actuarius]: http://henkelmann.eu/projects/actuarius/ [Knockoff] is copyright (c) 2009-2011 by Tristan Juricek
[Knockoff]: http://tristanhunt.com/projects/knockoff/ [PegDown] is copyright (c) 2010 by Mathias Doenitz
[PegDown]: https://github.com/sirthias/pegdown

---

Project link: https://github.com/rjeschke/txtmark