Package groovy.markdown

Class MarkdownSlurper

java.lang.Object

groovy.markdown.MarkdownSlurper

@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(true) after adding org.commonmark:commonmark-ext-gfm-tables to the runtime classpath.

Since:

6.0.0

Constructor Summary

Constructors

Constructor	Description
MarkdownSlurper()

Method Summary

Modifier and Type	Method	Description
MarkdownSlurper	enableTables(boolean enable)	Enable GFM-style tables.
MarkdownDocument	parse(File file)
MarkdownDocument	parse(InputStream stream)
MarkdownDocument	parse(Reader reader)
MarkdownDocument	parse(Path path)
MarkdownDocument	parseText(String md)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MarkdownSlurper

public MarkdownSlurper()

Method Details

enableTables

public MarkdownSlurper enableTables(boolean enable)

Enable GFM-style tables. Requires commonmark-ext-gfm-tables on the classpath.

Parameters:

enable - whether to enable table parsing

Returns:

this slurper for chaining

Throws:

MarkdownRuntimeException - if enable is true but the extension jar is missing

parseText

public MarkdownDocument parseText(String md)

parse

public MarkdownDocument parse(Reader reader)

parse

public MarkdownDocument parse(InputStream stream)

parse

public MarkdownDocument parse(File file)
                       throws IOException

Throws:

IOException

parse

public MarkdownDocument parse(Path path)
                       throws IOException

Throws:

IOException