EPUB
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.
Attributes
- Graph
-
- Supertypes
-
trait Singletontrait Producttrait Mirrortrait Serializabletrait Producttrait Equalstrait Formatclass Objecttrait Matchableclass AnyShow all
- Self type
-
EPUB.type
Members list
Type members
Classlikes
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.
Value parameters
- coverImage
-
the path to the cover image within the virtual document tree
- fonts
-
the fonts that should be embedded in the EPUB container
- metadata
-
the metadata associated with the document
- navigationDepth
-
the number of levels to generate a table of contents for
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
BookConfig.type
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
ScriptedTemplate.type
Configuration Enumeration that indicates whether an EPUB template contains scripting.
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.
Attributes
- Supertypes
-
trait RenderFormat[HTMLFormatter]trait Formatclass Objecttrait Matchableclass Any
- Self type
-
XHTML.type
Inherited types
The names of the product elements
The names of the product elements
Attributes
- Inherited from:
- Singleton
Attributes
- Inherited from:
- Singleton
The name of the type
The name of the type
Attributes
- Inherited from:
- Mirror
The mirrored *-type
The mirrored *-type
Attributes
- Inherited from:
- Singleton
Attributes
- Inherited from:
- Singleton
Value members
Concrete methods
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.
Attributes
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.
Attributes
Inherited methods
Create a new instance of type T with elements taken from product p.
Create a new instance of type T with elements taken from product p.
Attributes
- Inherited from:
- Singleton
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Concrete fields
Short string describing the markup or output format for tooling and logging.
Short string describing the markup or output format for tooling and logging.
Attributes
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.