Packages

o

laika.sbt

Tasks

object Tasks

Implementations for Laika's sbt tasks.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tasks
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait OutputFormat extends AnyRef

    Enumeration of output formats supported by the plugin.

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. val buildPreviewServer: sbt.Def.Initialize[Task[Resource[IO, Server]]]

    Creates a preview server as a cats.effect.Resource based on parser and input settings.

  6. val clean: sbt.Def.Initialize[Task[Unit]]

    Cleans the target directory of the site task.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. def collectInputFiles(inputs: InputTree[IO]): Set[sbt.File]

    Collects all input files from the specified input tree.

    Collects all input files from the specified input tree. Ignores any virtual inputs in the input trees.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. val generate: sbt.Def.Initialize[InputTask[Set[sbt.File]]]

    The main transformation task of the sbt plugin.

    The main transformation task of the sbt plugin.

    It accepts one or more arguments specifying the output formats. Valid arguments are html, pdf, xsl-fo and ast.

    The implementation parses the input document only once and then uses the AST obtained from the parsing operation to feed all specified renderers.

    The implementation is slightly bulky due to the nature of the sbt macros which would require any method being factored out to be tasks, too, which is not always desirable.

  12. val generateAPI: sbt.Def.Initialize[Task[Seq[String]]]

    Generates and copies the API documentation to the target directory of the site task.

    Generates and copies the API documentation to the target directory of the site task. Does nothing if the laikaIncludeAPI setting is set to false (the default).

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val mappings: sbt.Def.Initialize[Task[Seq[(sbt.File, String)]]]
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. val packageSite: sbt.Def.Initialize[Task[sbt.File]]

    Packages the generated html site and (optionally) the included API documentation and PDF/EPUB files into a zip archive.

  21. val site: sbt.Def.Initialize[Task[Set[sbt.File]]]

    The site task combines the html generator with optionally also rendering a PDF document from the same input and creating scaladoc documentation and copying both over to the target directory.

    The site task combines the html generator with optionally also rendering a PDF document from the same input and creating scaladoc documentation and copying both over to the target directory.

    PDF rendering and API generation is triggered by the laikaIncludeAPI and laikaIncludePDF settings respectively.

  22. val startPreviewServer: sbt.Def.Initialize[Task[Unit]]

    Launches an HTTP server for the generated site and e-books, auto-refreshing when inputs change.

    Launches an HTTP server for the generated site and e-books, auto-refreshing when inputs change. The server can be stopped with return/enter keys.

  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. object OutputFormat

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped