DocumentationVersioningConfig

Auf dieser Seite

Diese API-Referenz wird aus den englischen TypeScript-Quellkommentaren erzeugt. Namen, Signaturen und Beispiele entsprechen dem veröffentlichten Paket.

import type { DocumentationVersioningConfig } from "ardo/config"

type DocumentationVersioningConfig = {
    /** Active documentation version id for this build. */
    current: string;
    /** Major documentation versions available from the version switcher. */
    versions: DocumentationVersion[];
    /** Generate a static root redirect to the current version. Defaults to true. */
    rootRedirect?: boolean;
};

Properties

Name	Type	Required	Description
`current`	`string`	Yes	Active documentation version id for this build.
`versions`	`DocumentationVersion[]`	Yes	Major documentation versions available from the version switcher.
`rootRedirect`	`boolean`	No	Generate a static root redirect to the current version. Defaults to true.