|
| 1 | +:>>> DEPRECATION NOTE <<<: |
| 2 | +========================== |
| 3 | + |
| 4 | +Although still one of the most popular Markdown parsing libraries for the JVM, *pegdown* has reached its end of life. |
| 5 | + |
| 6 | +The project is essentially unmaintained with [tickets][issues] piling up and crucial bugs not being fixed.<br/> |
| 7 | +*pegdown*'s parsing performance isn't great. In some cases of pathological input runtime can even become exponential, |
| 8 | +which means that the parser either appears to "hang" completely or abort processing after a time-out. |
| 9 | + |
| 10 | +Therefore *pegdown* is not recommended anymore for use in new projects requiring a markdown parser.<br/> |
| 11 | +Instead I suggest you turn to [@vsch]'s [flexmark-java], which appears to be an excellent replacement for these reasons: |
| 12 | + |
| 13 | +* Modern parser architecture (based on [commonmark-java]), designed from the ground up as a *pegdown* replacement and |
| 14 | + supporting all its features and extensions |
| 15 | +* 30x better average parsing performance without pathological input cases |
| 16 | +* Configuration options for a multitude of markdown dialects ([CommonMark], pegdown, [MultiMarkdown], [kramdown] and [Markdown.pl]) |
| 17 | +* Actively maintained and used as the basis of an [IntelliJ plugin] with almost 2M downloads per year |
| 18 | +* The author ([@vsch]) has actively contributed to *pegdown* maintenance in the last two years and is intimately familiar with *pegdown*'s internals and quirks. |
| 19 | + |
| 20 | +In case you need support with migrating from *pegdown* to [flexmark-java], [@vsch] welcomes inquiries in [here][issues] or [here][flexmark-java issues]. |
| 21 | + |
| 22 | +[issues]: https://github.com/sirthias/pegdown/issues |
| 23 | +[@vsch]: https://github.com/vsch |
| 24 | +[flexmark-java]: https://github.com/vsch/flexmark-java |
| 25 | +[commonmark-java]: https://github.com/atlassian/commonmark-java |
| 26 | +[CommonMark]: http://spec.commonmark.org/0.27/ |
| 27 | +[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/ |
| 28 | +[kramdown]: https://kramdown.gettalong.org/ |
| 29 | +[Markdown.pl]: http://search.cpan.org/~sekimura/Text-Markdown-Discount-0.11/xt/MarkdownXS.pl |
| 30 | +[IntelliJ plugin]: https://vladsch.com/product/markdown-navigator |
| 31 | +[flexmark-java issues]: https://github.com/vsch/flexmark-java/issues |
| 32 | + |
| 33 | + |
| 34 | +--- |
| 35 | + |
| 36 | + |
1 | 37 | Introduction |
2 | 38 | ------------ |
3 | 39 | [](https://maven-badges.herokuapp.com/maven-central/org.pegdown/pegdown) |
|
0 commit comments