laika.render

HTML

class HTML extends RendererFactory[HTMLWriter]

A renderer 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
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HTML
  2. RendererFactory
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  10. val fileSuffix: String

    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
    HTMLRendererFactory
  11. def finalize(): Unit

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

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

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

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

    Definition Classes
    AnyRef
  16. def newRenderer(output: Output, render: (Element) ⇒ Unit): (HTMLWriter, (Element) ⇒ Unit)

    The actual setup method for providing both the writer API for customized renderers as well as the actual default render function itself.

    The actual setup method for providing both the writer API for customized renderers as well as the actual default render function itself. The default render function always only renders a single element and then delegates to the composite renderer passed to this function as a parameter when rendering children. This way user customizations are possible on a per-element basis.

    output

    the output to write to

    render

    the composite render function to delegate to when elements need to render their children

    returns

    a tuple consisting of the writer API for customizing the renderer as well as the actual default render function itself

    Definition Classes
    HTMLRendererFactory
  17. final def notify(): Unit

    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  20. def toString(): String

    Definition Classes
    AnyRef → Any
  21. def unformatted: HTML

    Renders HTML without any formatting (line breaks or indentation) around tags.

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

  22. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. def withMessageLevel(level: MessageLevel): HTML

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

Inherited from RendererFactory[HTMLWriter]

Inherited from AnyRef

Inherited from Any

Ungrouped