VersionConfig

Notedocblock

Configuration for multi-version documentation.

When enabled, documentation is deployed to versioned paths (e.g., /stable/, /dev/, /v1.0.0/) with a dropdown selector to switch between versions.

Fields

• enabled::Bool: Enable versioned documentation (default: false)
• current::String: Current version being built (auto-detected from Project.toml if empty)
• dev_url::String: URL segment for development docs (default: “dev”)
• stable_url::String: URL segment for stable release (default: “stable”)
• versions::Vector{String}: List of versions to show in selector (empty = auto-detect)
• keep_versions::Int: Number of older versions to keep (default: 5, 0 = all)
• dev_branch::String: Branch that triggers “dev” deployment (default: “main”)

Example

config = QuartoConfig(
    module_name = MyPackage,
    version = VersionConfig(
        enabled = true,
        dev_branch = "main",
        keep_versions = 5
    )
)

URL Structure

When enabled, documentation is deployed as:

• /stable/ - Symlink to latest release
• /dev/ - Development branch documentation
• /v1.0.0/ - Specific version documentation
• versions.json - Manifest of all available versions