laika-core/laika.api.builder/TwoPhaseRendererBuilder

TwoPhaseRendererBuilder

class TwoPhaseRendererBuilder[FMT, PP](val twoPhaseFormat: TwoPhaseRenderFormat[FMT, PP], val config: OperationConfig) extends RendererBuilderOps[FMT]

Builder API for Renderer instances.

Allows to add ExtensionBundles, to override the renderer for specific elements and other options.

Type parameters:
FMT

the formatter API to use which varies depending on the renderer

PP

the type of the post processor

class Object
trait Matchable
class Any

Type members

Types

Value members

Concrete methods

Inherited methods

def renderMessages(filter: MessageFilter): ThisType

Specifies the minimum required level for a runtime message to get included into the output by this renderer.

Specifies the minimum required level for a runtime message to get included into the output by this renderer.

Inherited from:
RendererBuilderOps
def rendering(customRenderer: PartialFunction[(FMT, Element), String]): ThisType

Specifies a custom render function that overrides one or more of the default renderers for the output format this instance uses.

Specifies a custom render function that overrides one or more of the default renderers for the output format this instance uses.

This method expects a partial function that takes a formatter and the element to render. It will then be invoked for each element it is defined at.

Simple example for customizing the HTML output for emphasized text, adding a specific style class:

val transformer = Transformer.from(Markdown).to(HTML).rendering {
  case (fmt, Emphasized(content, opt)) => fmt.element("em", opt, content, "class" -> "big")
}.build
Inherited from:
RendererBuilderOps
def unformatted: ThisType

Renders without any formatting (line breaks or indentation). Useful when storing the output in a database for example.

Renders without any formatting (line breaks or indentation). Useful when storing the output in a database for example.

Inherited from:
RendererBuilderOps
def using(bundles: ExtensionBundle*): ThisType

Returns a new instance with the specified extension bundles installed. Features in the new bundles may override features in already installed bundles.

Returns a new instance with the specified extension bundles installed. Features in the new bundles may override features in already installed bundles.

Bundles are usually provided by libraries (by Laika itself or a 3rd-party extension library) or as re-usable building blocks by application code.

Inherited from:
CommonBuilderOps

Concrete fields