@wollybeard/kit

Appearance

Paka.Adaptors.VitePress ​

Paka.Adaptors / VitePress

Import ​

typescript
import { Paka } from '@wollybeard/kit'

// Access via namespace
Paka.Adaptors.VitePress.someFunction()
typescript
import * as Paka from '@wollybeard/kit/paka'

// Access via namespace
Paka.Adaptors.VitePress.someFunction()

Functions ​

[F] generate ​

typescript
(model: Package, config: VitePressConfig): void
Source

Parameters:

  • model - The extracted interface model
  • config - VitePress generation configuration

Generate VitePress documentation from interface model.

Types ​

[T] VitePressConfig ​

typescript
type VitePressConfig = {
  /** Output directory for generated markdown files */
  outputDir: string
  /** Base URL for the docs site */
  baseUrl?: string
  /** GitHub repository URL for source links (e.g., 'https://github.com/owner/repo') */
  githubUrl?: string
  /** Group exports by @category tag (auto-detects if undefined) */
  groupByCategory?: boolean
}
Source

Configuration for VitePress generation.