Skip to content

SiteVersion

type SiteVersion =
    {
        Label: string
        Prefix: string
        IsLatest: bool
    }
AssemblyNacara.Plugin.Versions

One version of the documentation, as deployed.

Fields

Label: string

Shown in the switcher, for example 2.0 or next.

Prefix: string

URL segment this version lives under. Empty means the deployment root.

IsLatest: bool

The version a reader lands on by default.

Functions and values

create (label: string) (prefix: string) : SiteVersion

A version deployed under a prefix of its own.

Parameter
labelWhat the switcher calls it - 2.0, next.
prefixThe first segment of its URLs, and what --version wrote them under.
latest (version: SiteVersion) : SiteVersion

The version a reader arriving without one should be reading.

Parameter
versionThe version being described. Any other is shown with a notice saying it is not the current one.
root (label: string) : SiteVersion

The version served from the site root, under no prefix.

Parameter
labelWhat the switcher calls it.