11commonmark-java
22===============
33
4- Java implementation of [ CommonMark ] , a specification of the [ Markdown] format for turning plain text into formatted text.
5- Parses input to an AST (tree of nodes) and then renders to HTML .
4+ Java library for parsing and rendering [ Markdown] text according to the
5+ [ CommonMark ] specification ( and some extensions) .
66
7- This started out as a port of [ commonmark.js] and has evolved into a full
8- library with a nice Java API and some optional extensions. Features:
7+ Provides classes for parsing input to an abstract syntax tree of nodes
8+ (AST), visiting and manipulating nodes, and rendering to HTML. It
9+ started out as a port of [ commonmark.js] , but has since evolved into a
10+ full library with a nice API and the following features:
911
10- * Small with minimal dependencies
11- * Extensible (see below)
12+ * Small (minimal dependencies)
1213* Fast (10-20 times faster than pegdown, see benchmarks in repo)
14+ * Flexible (manipulate the AST after parsing, customize HTML rendering)
15+ * Extensible (tables, strikethrough, autolinking and more, see below)
1316
1417Requirements:
1518
1619* Java 7 or above
17- * Works on Android; minimum API level 15 (see [ commonmark-android-test] ( commonmark-android-test ) directory)
20+ * Works on Android, minimum API level 15 (see [ commonmark-android-test] ( commonmark-android-test ) directory)
1821* The core has no dependencies; for extensions, see below
1922
2023Coordinates for core library (see all on [ Maven Central] ):
@@ -162,7 +165,7 @@ literal: |
162165
163166document start here
164167```
165-
168+
166169Use class ` YamlFrontMatterExtension ` in artifact ` commonmark-ext-yaml-front-matter ` . To fetch metadata, use ` YamlFrontMatterVisitor ` .
167170
168171Contributing
@@ -183,7 +186,7 @@ an issue and explaining the intended change.
183186License
184187-------
185188
186- Copyright (c) 2015 Atlassian and others.
189+ Copyright (c) 2015-2016 Atlassian and others.
187190
188191BSD (2-clause) licensed, see LICENSE.txt file.
189192
0 commit comments