vitepress.ts

5 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.

5 symbols 5 functions 8 parameters 5 returns

Reference

fnconvertVitePressNav(nav: VitePressNavItem[]): SsgNavigationGroup[]Converts VitePress top navigation into ox-content sidebar groups. This is used…1 paramreturns SsgNavigationGroup[]

Converts VitePress top navigation into ox-content sidebar groups. This is used as a fallback when no explicit sidebar is defined.

Signature

export function convertVitePressNav(nav: VitePressNavItem[]): SsgNavigationGroup[]

View source

Parameters

nav VitePressNavItem[]

Returns

SsgNavigationGroup[]

fnconvertVitePressSidebar(sidebar: VitePressSidebar): SsgNavigationGroup[]Converts a VitePress sidebar config into ox-content navigation groups. Nested V…1 paramreturns SsgNavigationGroup[]

Converts a VitePress sidebar config into ox-content navigation groups. Nested VitePress items are flattened into the nearest ox-content group.

Signature

export function convertVitePressSidebar(sidebar: VitePressSidebar): SsgNavigationGroup[]

View source

Parameters

sidebar VitePressSidebar

Returns

SsgNavigationGroup[]

fnfromVitePressConfig(config: VitePressConfig, overrides: OxContentOptions = {}): OxContentOptionsCreates ox-content plugin options from an existing VitePress config.2 paramsreturns OxContentOptions

Creates ox-content plugin options from an existing VitePress config.

Signature

export function fromVitePressConfig(config: VitePressConfig, overrides: OxContentOptions = {}): OxContentOptions

View source

Parameters

config VitePressConfig
overrides OxContentOptions

optional · default: {}

Returns

OxContentOptions

generateVitePressMigrationConfig(config: VitePressConfig, overrides: OxContentOptions = {}, options: GenerateVitePressMigrationConfigOptions = {}): string

Generates a TypeScript module exporting migrated ox-content options. This is us…3 paramsreturns string

Generates a TypeScript module exporting migrated ox-content options.

This is used by the migration CLI so users can inspect and edit the resulting object instead of keeping a runtime dependency on their VitePress config.

Signature

export function generateVitePressMigrationConfig(config: VitePressConfig, overrides: OxContentOptions = {}, options: GenerateVitePressMigrationConfigOptions = {}): string

View source

Parameters

config VitePressConfig
overrides OxContentOptions

optional · default: {}
options GenerateVitePressMigrationConfigOptions

optional · default: {}

Returns

string

fnnormalizeVitePressFrontmatter(frontmatter: Record<string, unknown>): Record<string, unknown>Normalizes VitePress-specific frontmatter into ox-content's entry-page shape.1 paramreturns Record<string, unknown>

Normalizes VitePress-specific frontmatter into ox-content's entry-page shape.

Signature

export function normalizeVitePressFrontmatter(frontmatter: Record<string, unknown>): Record<string, unknown>

View source

Parameters

frontmatter Record<string, unknown>

Returns

Record<string, unknown>