OutputOps

laika.io.api.TreeRenderer.OutputOps
class OutputOps[F[_]]

Builder step that allows to specify the output to render to.

Attributes

Source
TreeRenderer.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Type members

Types

type Result = Op[F]

Attributes

Source
TreeRenderer.scala

Value members

Concrete methods

Copies the specified binary input to the output target, in addition to rendering the document tree.

Copies the specified binary input to the output target, in addition to rendering the document tree.

Attributes

Source
TreeRenderer.scala

Inherited methods

Builder step that instructs the runtime to render the document tree to files in the specified directory and its subdirectories.

Builder step that instructs the runtime to render the document tree to files in the specified directory and its subdirectories.

The virtual paths of the document tree will be translated to a directory structure, with the root of the virtual path being the directory specified with this method.

Value parameters

codec

the character encoding of the files, if not specified the platform default will be used.

dir

the directory to write to

Attributes

Inherited from:
TextOutputOps (hidden)
Source
TextOutputOps.scala
def toDirectory(name: String)(implicit codec: Codec): Result

Builder step that instructs the runtime to render the document tree to files in the specified directory and its subdirectories.

Builder step that instructs the runtime to render the document tree to files in the specified directory and its subdirectories.

The virtual paths of the document tree will be translated to a directory structure, with the root of the virtual path being the directory specified with this method.

Value parameters

codec

the character encoding of the files, if not specified the platform default will be used.

name

the name of the directory to write to

Attributes

Inherited from:
TextOutputOps (hidden)
Source
TextOutputOps.scala

Builder step that instructs the renderer to only produce an in - memory representation of the tree of rendered outputs.

Builder step that instructs the renderer to only produce an in - memory representation of the tree of rendered outputs.

Attributes

Inherited from:
TextOutputOps (hidden)
Source
TextOutputOps.scala