laika-core
API
Generated with
laika-core/laika/laika.format/HTML

HTML

laika.format.HTML$
case object HTML extends RenderFormat[HTMLFormatter]

A render format for HTML output. May be directly passed to the Render or Transform APIs:

Renderer.of(HTML).build.render(document)

Transformer.from(Markdown).to(HTML).build.transform(inputString)

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Format
class Object
trait Matchable
class Any
Show all
Self type
HTML.type

Members list

Type members

Inherited classlikes

case class Overrides(value: CustomRenderFunction[FMT]) extends RenderOverrides

Attributes

Inherited from:
RenderFormat
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Inherited types

type CustomRenderFunction[FMT] = PartialFunction[(FMT, Element), String]

Attributes

Inherited from:
RenderFormat
type MirroredElemLabels = EmptyTuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Singleton
type MirroredElemTypes = EmptyTuple

Attributes

Inherited from:
Singleton
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
type MirroredMonoType = Singleton.this.type

The mirrored *-type

The mirrored *-type

Attributes

Inherited from:
Singleton
type MirroredType = Singleton.this.type

Attributes

Inherited from:
Singleton

Value members

Inherited methods

def description: String

Short string describing the markup or output format for tooling and logging.

Short string describing the markup or output format for tooling and logging.

Attributes

Inherited from:
Format
def fromProduct(p: Product): MirroredMonoType

Create a new instance of type T with elements taken from product p.

Create a new instance of type T with elements taken from product p.

Attributes

Inherited from:
Singleton
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

val defaultRenderer: (HTMLFormatter, Element) => String

The default renderer function for this output format. It may be overridden by extensions for individual nodes of the AST.

The default renderer function for this output format. It may be overridden by extensions for individual nodes of the AST.

The function takes both, a formatter instance and the element to render and returns a String in the target format.

Attributes

val fileSuffix: String

The file suffix to use when rendering the output to a file. When transforming entire directories the suffix of the markup file will be automatically replaced by the suffix for the output format.

The file suffix to use when rendering the output to a file. When transforming entire directories the suffix of the markup file will be automatically replaced by the suffix for the output format.

Attributes

val formatterFactory: RenderContext[HTMLFormatter] => HTMLFormatter

The function for creating a new formatter for each render operation, based on the specified context containing the root element, the indentation mechanism and the delegate function for rendering child elements (that may contain user-specified extensions this render format implementation is not aware of).

The function for creating a new formatter for each render operation, based on the specified context containing the root element, the indentation mechanism and the delegate function for rendering child elements (that may contain user-specified extensions this render format implementation is not aware of).

The formatter created by this function (or copies created from it) will be used when invoking the default renderer.

Attributes

Generated with