object EPUB extends TwoPhaseRenderFormat[HTMLFormatter, BinaryPostProcessor]
A post processor for EPUB output, based on an interim HTML renderer.
May be directly passed to the Renderer
or Transformer
APIs:
implicit val cs: ContextShift[IO] = IO.contextShift(ExecutionContext.global) val blocker = Blocker.liftExecutionContext( ExecutionContext.fromExecutor(Executors.newCachedThreadPool()) ) val transformer = Transformer .from(Markdown) .to(EPUB) .using(GitHubFlavor) .io(blocker) .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.
- Alphabetic
- By Inheritance
- EPUB
- TwoPhaseRenderFormat
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
case class
Config(metadata: DocumentMetadata = DocumentMetadata(), tocDepth: Int = Int.MaxValue, tocTitle: Option[String] = None, coverImage: Option[String] = None) extends Product with Serializable
Configuration options for the generated EPUB output.
Configuration options for the generated EPUB output.
- metadata
the metadata associated with the document
- tocDepth
the number of levels to generate a table of contents for
- tocTitle
the title for the table of contents
- coverImage
the path to the cover image within the virtual document tree
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
val
interimFormat: RenderFormat[HTMLFormatter]
- Definition Classes
- EPUB → TwoPhaseRenderFormat
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
val
postProcessor: BinaryPostProcessor
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
-
def
prepareTree(tree: DocumentTreeRoot): 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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
object
Config extends Serializable
Companion for the creation of
Config
instances. -
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
orTransform
APIs. It is primarily used internally by the parentEPUB
instance.