laika.api

Transform

object Transform

Serves as an entry point to the Transform API.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Transform
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class BatchConfig(input: InputConfig, output: OutputConfig) extends Product with Serializable

    The configuration for a batch process, containing the configuration for the inputs and outputs to use.

  2. class BatchConfigBuilder extends AnyRef

    API for configuring a batch operation.

  3. class Builder extends AnyRef

    Step in the setup for a transform operation where the renderer must be specified.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. object BatchConfigBuilder

    Factory methods for creating BatchConfigBuilders.

  7. object DefaultDirectories

    Creates BatchConfigBuilder instances using the current working directory as its root.

  8. object RootDirectory

    Creates BatchConfigBuilder instances for a specific root directory in the file system.

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  13. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  14. def from(factory: ParserFactory): Builder

    Returns a new Builder instance for the specified parser factory.

    Returns a new Builder instance for the specified parser factory. This factory is usually an object provided by the library or a plugin that is capable of parsing a specific markup format like Markdown or reStructuredText. The returned builder can then be used to specifiy the renderer to create the actual Transform instance.

    factory

    the parser factory to use

    returns

    a new Builder instance for specifying the renderer

  15. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  16. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  22. def toString(): String

    Definition Classes
    AnyRef → Any

  23. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped