Packages

object PDF extends TwoPhaseRenderFormat[FOFormatter, BinaryPostProcessorBuilder]

A post processor for PDF output, based on an interim XSL-FO renderer. May be directly passed to the Render or Transform APIs:

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

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

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

Linear Supertypes
TwoPhaseRenderFormat[FOFormatter, BinaryPostProcessorBuilder], Format, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PDF
  2. TwoPhaseRenderFormat
  3. Format
  4. AnyRef
  5. 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 PDF output

    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 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
    PDF → Format
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. val interimFormat: RenderFormat[FOFormatter]

    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
    PDF → 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() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def postProcessor: BinaryPostProcessorBuilder

    Processes the interim XSL-FO result, transforms it to PDF and writes it to the specified final output.

    Processes the interim XSL-FO result, transforms it to PDF and writes it to the specified final output.

    Definition Classes
    PDF → TwoPhaseRenderFormat
  17. def prepareTree(root: DocumentTreeRoot): Either[Throwable, DocumentTreeRoot]

    Adds a preamble to each document for navigation and replaces the template with a fallback.

    Adds a preamble to each document for navigation and replaces the template with a fallback. The modified tree will be used for rendering the interim XSL-FO result. The original template will only be applied to the concatenated result of the XSL-FO renderer in a later step.

    Definition Classes
    PDF → TwoPhaseRenderFormat
  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( ... )
  23. object BookConfig extends Serializable

Deprecated Value Members

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

Inherited from TwoPhaseRenderFormat[FOFormatter, BinaryPostProcessorBuilder]

Inherited from Format

Inherited from AnyRef

Inherited from Any

Ungrouped