Version

laika.config.Version
See theVersion companion object
sealed abstract class Version

Configuration for a single version of the documentation.

Attributes

Companion
object
Source
Version.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def canonical: Boolean

Indicates whether this is the canonical version.

Indicates whether this is the canonical version.

When using the Helium theme setting this flag results in canonical link references getting inserted into the HTML head section of the generated output.

Attributes

Source
Version.scala
def displayValue: String

The description of the version to use in any UI (for example in version dropdowns).

The description of the version to use in any UI (for example in version dropdowns).

Attributes

Source
Version.scala
def label: Option[String]

An optional label that will be used in the UI (e.g.

An optional label that will be used in the UI (e.g. Dev or Stable).

Attributes

Source
Version.scala
def pathSegment: String

The string to use as a path segments in URLs pointing to this version.

The string to use as a path segments in URLs pointing to this version.

Attributes

Source
Version.scala

Attributes

Source
Version.scala
def withLabel(value: String): Version

Attributes

Source
Version.scala