Object

laika.format

HTML

Related Doc: package format

Permalink

object HTML extends RenderFormat[HTMLWriter]

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

Render as HTML from document toFile "hello.html"

Transform from Markdown to HTML fromFile "hello.md" toFile "hello.html"
Linear Supertypes
RenderFormat[HTMLWriter], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HTML
  2. RenderFormat
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Theme(customRenderer: (W) ⇒ RenderFunction = _: W => PartialFunction.empty, defaultTemplate: Option[TemplateRoot] = None, defaultStyles: StyleDeclarationSet = StyleDeclarationSet.empty, staticDocuments: StaticDocuments = StaticDocuments.empty) extends RenderTheme with Product with Serializable

    Permalink
    Definition Classes
    RenderFormat

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. lazy val defaultTheme: Theme

    Permalink

    The default theme to use if no theme is explicitly specified.

    The default theme to use if no theme is explicitly specified.

    Definition Classes
    HTMLRenderFormat
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. val fileSuffix: String

    Permalink

    The file suffix to use when rendering the output to a file.

    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.

    Definition Classes
    HTMLRenderFormat
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def newRenderer(output: Output, root: Element, render: (Element) ⇒ Unit, styles: StyleDeclarationSet, config: RenderConfig): (HTMLWriter, (Element) ⇒ Unit)

    Permalink

    Creates a new renderer and a new writer instance for the specified output and delegate renderer.

    Creates a new renderer and a new writer instance for the specified output and delegate renderer. The delegate function needs to be used whenever an element renders its children, as the user might have installed custom renderer overrides this instance is not aware of. If no custom renderer is responsible for the children, the invocation will fall back to calling this renderer again.

    In contrast to the parser function, a new render function will be created for each render operation. In addition to the actual renderer function, this method also produces an instance of the generic W type which is the writer API to use for custom renderer functions and which is specific to the output format.

    root

    the root element the new renderer will be used for

    styles

    the styles the new renderer should apply to the rendered elements

    config

    additional configuration for the renderer

    returns

    a new writer API of type W and a new render function

    Definition Classes
    HTMLRenderFormat
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from RenderFormat[HTMLWriter]

Inherited from AnyRef

Inherited from Any

Ungrouped