Packages

object EPUB extends TwoPhaseRenderFormat[HTMLFormatter, BinaryPostProcessorBuilder] with Product with Serializable

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.

Linear Supertypes
Serializable, Serializable, Product, Equals, TwoPhaseRenderFormat[HTMLFormatter, BinaryPostProcessorBuilder], Format, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EPUB
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. TwoPhaseRenderFormat
  7. Format
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class BookConfig(metadata: DocumentMetadata = DocumentMetadata(), navigationDepth: Option[Int] = None, fonts: Seq[FontDefinition] = Nil, coverImage: Option[Path] = None) extends Product with Serializable

    Configuration options for the generated EPUB output.

    Configuration options for the generated EPUB output.

    The duplication of the existing BookConfig instance from laika-core happens to have a different implicit key association with the EPUB-specific instance.

    metadata

    the metadata associated with the document

    navigationDepth

    the number of levels to generate a table of contents for

    fonts

    the fonts that should be embedded in the EPUB container

    coverImage

    the path to the cover image within the virtual document tree

  2. sealed trait ScriptedTemplate extends Product

    Configuration Enumeration that indicates whether an EPUB template contains scripting.

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()
  6. 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
    EPUB → Format
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. val interimFormat: RenderFormat[HTMLFormatter]

    The render format for the interim result, the first phase of this renderer.

    The render format for the interim result, the first phase of this renderer.

    Definition Classes
    EPUB → TwoPhaseRenderFormat
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def postProcessor: BinaryPostProcessorBuilder

    Produces an EPUB container from the specified result tree.

    Produces an EPUB container from the specified result tree.

    It includes the following files in the container:

    • All text markup in the provided document tree, transformed to HTML by the specified render function.
    • All static content in the provided document tree, copied to the same relative path within the EPUB container.
    • Metadata and navigation files as required by the EPUB specification, auto-generated from the document tree and the configuration of this instance.
    Definition Classes
    EPUB → TwoPhaseRenderFormat
  17. def prepareTree(root: DocumentTreeRoot): Either[Throwable, DocumentTreeRoot]

    Adds a cover image (if specified in the configuration) and a fallback CSS resource (if the input tree did not contain any CSS), before the tree gets passed to the XHTML renderer.

    Adds a cover image (if specified in the configuration) and a fallback CSS resource (if the input tree did not contain any CSS), before the tree gets passed to the XHTML renderer.

    Definition Classes
    EPUB → TwoPhaseRenderFormat
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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. object BookConfig extends Serializable
  23. object ScriptedTemplate
  24. object XHTML extends RenderFormat[HTMLFormatter]

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

    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.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from TwoPhaseRenderFormat[HTMLFormatter, BinaryPostProcessorBuilder]

Inherited from Format

Inherited from AnyRef

Inherited from Any

Ungrouped