laika.rewrite.Versions
See theVersions companion object
case class Versions(currentVersion: Version, olderVersions: Seq[Version], newerVersions: Seq[Version], renderUnversioned: Boolean, scannerConfig: Option[VersionScannerConfig])
Global configuration for versioned documentation.
The order in the Seq properties will be used for any list views in the UI (e.g. for the version chooser dropdown).
Value parameters
- currentVersion
-
the version that the sources of a transformation produce
- newerVersions
-
list of newer versions that have previously been rendered (may be empty)
- olderVersions
-
list of older versions that have previously been rendered (may be empty)
- renderUnversioned
-
indicates whether unversioned documents should be rendered (setting this to false may be useful when re-rendering older versions)
- scannerConfig
-
optional configuration for scanning and indexing existing versions, used by the Helium version switcher dropdown and by the preview server.
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Members list
In this article