object Tasks
Implementations for Laika's sbt tasks.
- Alphabetic
- By Inheritance
- Tasks
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
sealed
trait
OutputFormat extends AnyRef
Enumeration of output formats supported by the plugin.
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
-
val
buildPreviewServer: sbt.Def.Initialize[Task[Resource[IO, Server]]]
Creates a preview server as a
cats.effect.Resource
based on parser and input settings. -
val
clean: sbt.Def.Initialize[Task[Unit]]
Cleans the target directory of the site task.
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
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.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
andast
.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.
-
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). -
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val mappings: sbt.Def.Initialize[Task[Seq[(sbt.File, String)]]]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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.
-
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
andlaikaIncludePDF
settings respectively. -
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.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- object OutputFormat
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated