B C D E F H M O P R S

B

BlockEmitter - Interface in com.github.rjeschke.txtmark

Block emitter interface.

build() - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Builds a configuration instance.

builder() - Static method in class com.github.rjeschke.txtmark.Configuration

Creates a new Builder instance.

C

closeBlockquote(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a blockquote is closed.

closeBlockquote(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeCodeBlock(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a code block is closed.

closeCodeBlock(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeCodeSpan(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a code span is closed.

closeCodeSpan(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeEmphasis(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an emphasis span is closed.

closeEmphasis(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeHeadline(StringBuilder, int) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a headline is closed.

closeHeadline(StringBuilder, int) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeImage(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an image is closed.

closeImage(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeLink(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a link is closed

closeLink(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeListItem(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a list item is closed.

closeListItem(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeOrderedList(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an ordered list is closed.

closeOrderedList(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeParagraph(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a paragraph is closed.

closeParagraph(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeStrong(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a strong span is closed.

closeStrong(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeSuper(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a superscript span is closed.

closeSuper(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeUnorderedList(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an unordered list is closed.

closeUnorderedList(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

com.github.rjeschke.txtmark - package com.github.rjeschke.txtmark

com.github.rjeschke.txtmark.cmd - package com.github.rjeschke.txtmark.cmd

Configuration - Class in com.github.rjeschke.txtmark

Txtmark configuration.

Configuration.Builder - Class in com.github.rjeschke.txtmark

Configuration builder.

D

Decorator - Interface in com.github.rjeschke.txtmark

Decorator interface.

DEFAULT - Static variable in class com.github.rjeschke.txtmark.Configuration

This is the default configuration for txtmark's process methods

DEFAULT_SAFE - Static variable in class com.github.rjeschke.txtmark.Configuration

Default safe configuration

DefaultDecorator - Class in com.github.rjeschke.txtmark

Default Decorator implementation.

DefaultDecorator() - Constructor for class com.github.rjeschke.txtmark.DefaultDecorator

Constructor.

E

emitBlock(StringBuilder, List<String>, String) - Method in interface com.github.rjeschke.txtmark.BlockEmitter

This method is responsible for outputting a markdown block and for any needed pre-processing like escaping HTML special characters.

emitSpan(StringBuilder, String) - Method in interface com.github.rjeschke.txtmark.SpanEmitter

Emits a span element.

enablePanicMode() - Method in class com.github.rjeschke.txtmark.Configuration.Builder

This allows you to enable 'panicMode'.

enableSafeMode() - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Enables HTML safe mode.

F

forceExtentedProfile() - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Forces extened profile to be enabled by default.

H

horizontalRuler(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a horizontal ruler is encountered.

horizontalRuler(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

M

main(String[]) - Static method in class com.github.rjeschke.txtmark.cmd.Run

main(String[]) - Static method in class com.github.rjeschke.txtmark.Run

Static main.

O

openBlockquote(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a blockquote is opened.

openBlockquote(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openCodeBlock(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a code block is opened.

openCodeBlock(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openCodeSpan(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a code span is opened.

openCodeSpan(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openEmphasis(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an emphasis span is opened.

openEmphasis(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openHeadline(StringBuilder, int) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a headline is opened.

openHeadline(StringBuilder, int) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openImage(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an image is opened.

openImage(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openLink(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a link is opened.

openLink(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openListItem(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a list item is opened.

openListItem(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openOrderedList(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an ordered list is opened.

openOrderedList(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openParagraph(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a paragraph is opened.

openParagraph(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openStrong(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a strong span is opened.

openStrong(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openSuper(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a superscript span is opened.

openSuper(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openUnorderedList(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an unordered list is opened.

openUnorderedList(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

P

process(Reader, Configuration) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML using the given Configuration.

process(String, Configuration) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input String into HTML using the given Configuration.

process(File, Configuration) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML using the given Configuration.

process(InputStream, Configuration) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML using the given Configuration.

process(String) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input String into HTML using the default Configuration.

process(String, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input String into HTML.

process(String, Decorator) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input String into HTML.

process(String, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input String into HTML.

process(File) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML using the default Configuration.

process(File, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(File, Decorator) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(File, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(File, String) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(File, String, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(File, String, Decorator) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(File, String, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(InputStream) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, Decorator) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, String) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, String, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, String, Decorator) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, String, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(Reader) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML using the default Configuration.

process(Reader, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(Reader, Decorator) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(Reader, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

Processor - Class in com.github.rjeschke.txtmark

Markdown processor class.

R

Run - Class in com.github.rjeschke.txtmark.cmd

Run() - Constructor for class com.github.rjeschke.txtmark.cmd.Run

Run - Class in com.github.rjeschke.txtmark

Simple class for processing markdown files on the command line.

Run() - Constructor for class com.github.rjeschke.txtmark.Run

S

setAllowSpacesInFencedCodeBlockDelimiters(boolean) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

(Dis-)Allows spaces in fenced code block delimiter lines.

setCodeBlockEmitter(BlockEmitter) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Sets the code block emitter.

setDecorator(Decorator) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Sets the decorator for txtmark.

setEnablePanicMode(boolean) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

This allows you to enable 'panicMode'.

setEncoding(String) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Sets the character encoding for txtmark.

setSafeMode(boolean) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Sets the HTML safe mode flag.

setSpecialLinkEmitter(SpanEmitter) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Sets the emitter for special link spans ([[ ...

SpanEmitter - Interface in com.github.rjeschke.txtmark

An interface for emitting span elements.

B C D E F H M O P R S