@Incubating
public class MarkdownSlurper
extends Object
Parses CommonMark Markdown into a MarkdownDocument backed by nested lists and maps.
Usage:
def doc = new groovy.markdown.MarkdownSlurper().parseText('# Hello')
assert doc.headings[0].text == 'Hello'
GFM-style tables are supported via an optional extension. Call
enableTables(boolean) enableTables(true) after adding
org.commonmark:commonmark-ext-gfm-tables to the runtime classpath.
| Type Params | Return Type | Name and description |
|---|---|---|
|
public MarkdownSlurper |
enableTables(boolean enable)Enable GFM-style tables. |
|
public MarkdownDocument |
parse(Reader reader) |
|
public MarkdownDocument |
parse(InputStream stream) |
|
public MarkdownDocument |
parse(File file) |
|
public MarkdownDocument |
parse(Path path) |
|
public MarkdownDocument |
parseText(String md) |
Enable GFM-style tables. Requires commonmark-ext-gfm-tables on the classpath.
enable is true but the extension jar is missingenable - whether to enable table parsing