Transformer

laika.api.Transformer
See theTransformer companion object
class Transformer(val parser: MarkupParser, val renderer: Renderer)

Performs a transformation from text markup like Markdown or reStructuredText to a target format like HTML as a String.

Example for transforming from Markdown to HTML:

val res: Either[ParserError, String] = Transformer
  .from(Markdown)
  .to(HTML)
  .using(GitHubFlavor)
  .build
  .transform("hello *there*)

This is a pure API that does not perform any side-effects. For additional options like File and Stream I/O, templating or parallel processing, use the corresponding builders in the laika-io module.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def transform(input: String): Either[TransformationError, String]
def transform(input: String, path: Path): Either[TransformationError, String]

Concrete fields