types.ts
37 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.
Reference
typeCodeAnnotationKind = "highlight" | "warning" | "error"Supported line annotation kinds for code blocks.
Supported line annotation kinds for code blocks.
interfaceCodeAnnotationsOptionsOpt-in code annotation configuration.
Opt-in code annotation configuration.
typeCodeAnnotationSyntax = "attribute" | "vitepress" | "both"Supported code annotation syntaxes.
Supported code annotation syntaxes.
interfaceDocEntryA single documentation entry extracted from source.
A single documentation entry extracted from source.
interfaceDocsOptionsOptions for source documentation generation.
Options for source documentation generation.
interfaceEntryPageConfigEntry page frontmatter configuration.
Entry page frontmatter configuration.
interfaceExtractedDocsExtracted documentation for a single file.
Extracted documentation for a single file.
interfaceFeatureConfigFeature card for entry page.
Feature card for entry page.
interfaceGeneratedDocsDataMachine-readable payload emitted alongside generated docs.
Machine-readable payload emitted alongside generated docs.
interfaceHeroActionHero section action button.
Hero section action button.
interfaceHeroConfigHero section configuration for entry page.
Hero section configuration for entry page.
interfaceHeroImageHero section image configuration.
Hero section image configuration.
interfaceHeroNoticeHero notice configuration.
Hero notice configuration.
interfaceI18nOptionsi18n (internationalization) options.
i18n (internationalization) options.
interfaceLocaleConfigLocale configuration.
Locale configuration.
interfaceMarkdownNodeMarkdown AST node (simplified for TypeScript).
Markdown AST node (simplified for TypeScript).
interfaceMarkdownTransformerCustom AST transformer.
Custom AST transformer.
interfaceOgImageOptionsOG image generation options. Uses Chromium-based rendering with customizable te…
OG image generation options. Uses Chromium-based rendering with customizable templates.
interfaceOxContentOptionsPlugin options.
Plugin options.
interfaceParamDocParameter documentation.
Parameter documentation.
interfaceResolvedCodeAnnotationsOptionsResolved code annotation configuration.
Resolved code annotation configuration.
interfaceResolvedDocsOptionsResolved docs options with all defaults applied.
Resolved docs options with all defaults applied.
interfaceResolvedI18nOptionsResolved i18n options with all defaults applied.
Resolved i18n options with all defaults applied.
interfaceResolvedOgImageOptionsResolved OG image options with all defaults applied.
Resolved OG image options with all defaults applied.
interfaceResolvedOptionsResolved options with all defaults applied.
Resolved options with all defaults applied.
interfaceResolvedSearchOptionsResolved search options.
Resolved search options.
interfaceResolvedSsgOptionsResolved SSG options.
Resolved SSG options.
interfaceReturnDocReturn type documentation.
Return type documentation.
interfaceScopedSearchQueryParsed search query with optional scope prefixes.
Parsed search query with optional scope prefixes.
interfaceSearchDocumentSearch document structure.
Search document structure.
interfaceSearchOptionsOptions for full-text search.
Options for full-text search.
interfaceSearchResultSearch result structure.
Search result structure.
interfaceSsgOptionsSSG (Static Site Generation) options.
SSG (Static Site Generation) options.
interfaceTocEntryTable of contents entry.
Table of contents entry.
interfaceTransformContextTransform context passed to transformers.
Transform context passed to transformers.
interfaceTransformResultTransform result.
Transform result.