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.
- Companion:
- object
Value members
Concrete methods
Validates this configuration instance and either returns a Left with a
list of errors encountered or a Right containing this instance.
Validates this configuration instance and either returns a Left with a
list of errors encountered or a Right containing this instance.
Configures the version scanner to use during transformations. These settings enable scanning and indexing existing versions during a transformation, used by the Helium version switcher dropdown and by the preview server.
Configures the version scanner to use during transformations. These settings enable scanning and indexing existing versions during a transformation, used by the Helium version switcher dropdown and by the preview server.