Packages

  • package root
    Definition Classes
    root
  • package laika
    Definition Classes
    root
  • package format
    Definition Classes
    laika
  • object EPUB extends TwoPhaseRenderFormat[HTMLFormatter, BinaryPostProcessorBuilder] with Product with Serializable

    A post processor for EPUB output, based on an interim HTML renderer.

    A post processor for EPUB output, based on an interim HTML renderer. May be directly passed to the Renderer or Transformer APIs:

    val transformer = Transformer
  .from(Markdown)
  .to(EPUB)
  .using(GitHubFlavor)
  .parallel[IO]
  .build

val res: IO[Unit] = transformer
  .fromDirectory("src")
  .toFile("demo.epub")
  .transform

    In the example above the input from an entire directory gets merged into a single output file.

    Definition Classes
    format
  • BookConfig
  • ScriptedTemplate
  • XHTML

object XHTML extends RenderFormat[HTMLFormatter]

A render format for XHTML output as used by EPUB output.

This format is usually not used directly with Laika's Render or Transform APIs. It is primarily used internally by the parent EPUB instance.

Linear Supertypes
RenderFormat[HTMLFormatter], Format, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. XHTML
  2. RenderFormat
  3. Format
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Overrides(value: CustomRenderFunction[FMT] = PartialFunction.empty) extends RenderOverrides with Product with Serializable
    Definition Classes
    RenderFormat
  2. type CustomRenderFunction[FMT] = PartialFunction[(FMT, Element), String]
    Definition Classes
    RenderFormat

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. val defaultRenderer: (HTMLFormatter, Element) ⇒ String

    The default renderer function for this output format.

    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.

    Definition Classes
    XHTML → RenderFormat
  7. val 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.

    Definition Classes
    XHTML → Format
  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
    XHTML → RenderFormat
  11. 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.

    Definition Classes
    XHTML → RenderFormat
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from RenderFormat[HTMLFormatter]

Inherited from Format

Inherited from AnyRef

Inherited from Any

Ungrouped