case class VersionScannerConfig(rootDirectory: String, exclude: Seq[Path] = Nil) extends Product with Serializable
Optional configuration for scanning existing versions that had been generated by a different tool. This setting is optional and serves two purposes:
- If older versions of the documentation had been generated by different tools,
Laika can use this configuration for indexing the available paths for "smart linking",
which is a feature of the Helium version switcher drop down.
The result of the scanning operation will be used to populate the file /laika/versionInfo.json
in the output directory.
- If you are using the preview server (either the laikaPreview task in the sbt plugin,
or the laika.preview.ServerBuilder from the API) and you want to also test the version switcher
drop down menu, then Laika needs to know where older versions are located so that it can serve them, too.
The specified root directory is expected to match the structure of versioned documentation as rendered by Laika.
This means that the root directory is expected to have immediate sub-directories with names that correspond
to the pathSegment property of the configuration for that version.
- rootDirectory
file system path that represents the root of existing versions.
- exclude
paths to be skipped when scanning the output directory for existing versions (e.g. for API docs), interpreted from the root directory of each version.
- Alphabetic
- By Inheritance
- VersionScannerConfig
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
VersionScannerConfig(rootDirectory: String, exclude: Seq[Path] = Nil)
- rootDirectory
file system path that represents the root of existing versions.
- exclude
paths to be skipped when scanning the output directory for existing versions (e.g. for API docs), interpreted from the root directory of each version.
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
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val exclude: Seq[Path]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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 rootDirectory: String
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated