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

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.

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

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BookConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BookConfig(metadata: DocumentMetadata = DocumentMetadata(), navigationDepth: Option[Int] = None, fonts: Seq[FontDefinition] = Nil, coverImage: Option[Path] = None)

    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

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 coverImage: Option[Path]
  7. lazy val date: OffsetDateTime
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. val fonts: Seq[FontDefinition]
  10. lazy val formattedDate: String
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. lazy val identifier: String
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. lazy val language: String
  15. val metadata: DocumentMetadata
  16. val navigationDepth: Option[Int]
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  23. 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 Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped