types.ts

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

73 symbols 67 interfaces 5 types 1 modules 422 members

Reference

interfaceAttrsOptionsOptions for markdown-it-attrs style attribute blocks. Attribute blocks let auth…1 member

Options for markdown-it-attrs style attribute blocks.

Attribute blocks let authors attach IDs, classes, and key/value attributes to nearby Markdown nodes with syntax such as {#install .lead}.

Signature

export interface AttrsOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable the attrs transform when an options object is supplied. Set to `false` to keep the object shape while disabling the transform. This is mainly useful for config merging where callers want to preserve a stable object structure. Default `true`

interfaceBuiltinEmbedOptionsBuilt-in embed configuration.8 members

Built-in embed configuration.

Signature

export interface BuiltinEmbedOptions

View source

Members

Properties

Name	Type	Description
`bluesky`optional	`boolean`	Render `<Bluesky>` as static cards. Default `false`
`github`optional	`boolean \| GitHubOptions`	Render `<GitHub repo="owner/name" />` repository cards. Pass an options object to configure fetching. Default `true`
`openGraph`optional	`boolean \| OgpOptions`	Render `<OgCard url="https://example.com" />` Open Graph link cards. Pass an options object to configure fetching. Default `true`
`pm`optional	`boolean \| BuiltinPmOptions`	Expand `<pm>npm install …</pm>` blocks into npm/pnpm/yarn/bun install tabs. Accepts a boolean to toggle the feature, or an options object to opt in to synced tab groups. Synced groups are OFF by default; when enabled with `{ sync: true }`, selecting a package manager in one block selects it in every other package-manager block on the page (persisted in localStorage). Default `false`
`spotify`optional	`boolean`	Render `<Spotify url="https://open.spotify.com/track/...">` iframes. Default `false`
`stackBlitz`optional	`boolean`	Render `<StackBlitz url="https://stackblitz.com/edit/...">` iframes. Default `false`
`twitter`optional	`boolean \| TwitterEmbedOptions`	Render `<Tweet>` / `<XPost>` as static privacy-conscious cards. Pass `{ fetch: true }` to fetch the post body, author, and self-hosted media at build time. Fetch failures fall back to the link-only card. Default `false`
`webContainer`optional	`boolean`	Render `<WebContainer>` lazy placeholders with isolation metadata. Default `false`

interfaceBuiltinPmOptionsOptions for the package-manager install-tab transform.1 member

Options for the package-manager install-tab transform.

Signature

export interface BuiltinPmOptions

View source

Members

Properties

Name	Type	Description
`sync`optional	`boolean`	Enable opt-in synced package-manager tab groups. Default `false`

typeCodeAnnotationKind = "highlight" | "warning" | "error"Supported line annotation kinds for code blocks.

Supported line annotation kinds for code blocks.

Signature

export type CodeAnnotationKind = "highlight" | "warning" | "error"

View source

interfaceCodeAnnotationsOptionsOpt-in code annotation configuration.3 members

Opt-in code annotation configuration.

Signature

export interface CodeAnnotationsOptions

View source

Members

Properties

Name	Type	Description
`defaultLineNumbers`optional	`boolean`	Enable line numbers for all code blocks by default. In `vitepress` or `both` mode, fenced code blocks can override this with `:line-numbers`, `:line-numbers=<start>`, or `:no-line-numbers`. Default `false`
`metaKey`optional	`string`	Attribute name read from the code fence meta string. Example: `annotate="highlight:1,3-4;warning:6"` Default `"annotate"`
`notation`optional	`CodeAnnotationSyntax`	Annotation syntax to enable. - `attribute`: custom attribute syntax like `annotate="highlight:1,3-4"` - `vitepress`: VitePress-compatible syntax like `{1,3-4}` and `[!code warning]` - `both`: enables both syntaxes Default `"attribute"`

typeCodeAnnotationSyntax = "attribute" | "vitepress" | "both"Supported code annotation syntaxes.

Supported code annotation syntaxes.

Signature

export type CodeAnnotationSyntax = "attribute" | "vitepress" | "both"

View source

interfaceCodeBlockLintOptionsOptions for linting fenced code blocks during Markdown transforms. These checks…4 members

Options for linting fenced code blocks during Markdown transforms.

These checks are intentionally local to each fence. They do not execute code or parse a project graph, so they are safe to run during normal Markdown transformation.

Signature

export interface CodeBlockLintOptions

View source

Members

Properties

Name	Type	Description
`languages`optional	`string[]`	Languages to lint. Omit to lint every fenced block language. Language names are compared case-insensitively. Default `undefined`
`mode`optional	`"warn" \| "error"`	Diagnostic severity for lint failures. Use `'error'` when code-block lint failures should fail the build. Default `'warn'`
`requireLanguage`optional	`boolean`	Require every fenced code block to declare a language. This is helpful for documentation sites where every example should be highlighted and searchable by language. Default `false`
`trailingSpaces`optional	`boolean`	Report trailing whitespace inside fenced code blocks. The check reports the exact line and column range inside the fence content. Default `true`

interfaceCodeBlockTypecheckOptionsOptions for type-checking TypeScript and TSX fenced code blocks. Type-checking…4 members

Options for type-checking TypeScript and TSX fenced code blocks.

Type-checking writes matching snippets to a temporary directory and invokes tsgo. It is best suited for concise examples that should stay synchronized with the public TypeScript API.

Signature

export interface CodeBlockTypecheckOptions

View source

Members

Properties

Name	Type	Description
`languages`optional	`string[]`	Fence languages to type-check. Language names are compared case-insensitively. Default `['ts', 'tsx']`
`mode`optional	`"warn" \| "error"`	Diagnostic severity for type-check failures. Use `'error'` to fail the Markdown transform on broken snippets. Default `'warn'`
`requireMeta`optional	`boolean`	Require an opt-in fence meta marker before type-checking. When enabled, only fences with metadata such as `typecheck` or `twoslash` are checked. Default `true`
`tsgoCommand`optional	`string`	Command used to run the TypeScript checker. Override this for package-manager scripts or workspace-local binaries. Default `'tsgo'`

interfaceCodeImportOptionsOptions for importing source snippets into code fences. The transform resolves…1 member

Options for importing source snippets into code fences.

The transform resolves <<< imports before code highlighting and other code-block features run. Imported snippets therefore behave like ordinary fenced code in later stages.

Signature

export interface CodeImportOptions

View source

Members

Properties

Name	Type	Description
`rootDir`optional	`string`	Directory used to resolve `<<<` imports. When omitted, imports resolve from the Vite project root and configured aliases. Default `undefined`

interfaceCollectionEntryQueryable Markdown collection entry.13 members

Queryable Markdown collection entry.

Signature

export interface CollectionEntry

View source

Members

Indexable

[key: string]: unknown

Properties

Name	Type	Description
`body`optional	`string`
`collection`	`string`
`description`optional	`string`
`extension`	`string`
`frontmatter`	`Record<string, unknown>`
`html`optional	`string`
`id`	`string`
`path`	`string`
`source`	`string`
`stem`	`string`
`title`	`string`
`toc`optional	`TocEntry[]`

typeCollectionIncludeField = "body" | "html" | "toc"Extra payload fields embedded into collection entries. Keep this list small for…

Extra payload fields embedded into collection entries.

Keep this list small for large sites. By default collection entries contain only route metadata and frontmatter. body, html, and toc increase the virtual module size, and html/toc require a native Markdown transform.

Signature

export type CollectionIncludeField = "body" | "html" | "toc"

View source

interfaceCollectionManifestGenerated collection manifest.1 member

Generated collection manifest.

Signature

export interface CollectionManifest

View source

Members

Properties

Name	Type	Description
`collections`	`Record<string, CollectionEntry[]>`

interfaceCollectionOptionsCollection source configuration.2 members

Collection source configuration.

Signature

export interface CollectionOptions

View source

Members

Properties

Name	Type	Description
`include`optional	`readonly CollectionIncludeField[]`	Optional fields to include in each entry. The default is metadata-only for performance. Use `body` for stripped raw Markdown, `html` for native rendered HTML, and `toc` for the parsed table of contents. Default `[]`
`source`optional	`string \| readonly string[]`	Glob pattern(s) resolved from `srcDir`. Patterns are filtered by the configured Markdown extensions. Numeric route prefixes such as `1.guide/2.install.md` are stripped from generated `path`. Default `all Markdown files`

typeCollectionsOptions = Record<string, CollectionOptions | string | readonly string[]>Top-level collection definitions.

Top-level collection definitions.

Signature

export type CollectionsOptions = Record<string, CollectionOptions | string | readonly string[]>

View source

interfaceDocEntryA single documentation entry extracted from source. Entries represent top-level…14 members

A single documentation entry extracted from source.

Entries represent top-level declarations such as functions, classes, interfaces, type aliases, enums, variables, and modules. Members of compound declarations are stored in members.

Signature

export interface DocEntry

View source

Members

Properties

Name	Type	Description
`description`	`string`	Main prose extracted from the leading JSDoc/TSDoc block.
`endLine`	`number`	1-based end line of the declaration in the source file.
`examples`optional	`string[]`	Code examples collected from `@example` tags.
`file`	`string`	Source file path relative to the extraction root when available.
`kind`	`"function" \| "class" \| "interface" \| "type" \| "enum" \| "variable" \| "module"`	Normalized declaration kind used for grouping and rendering.
`line`	`number`	1-based start line of the declaration in the source file.
`members`optional	`DocMember[]`	Members belonging to classes, interfaces, object types, and enums.
`name`	`string`	Exported or declared symbol name.
`params`optional	`ParamDoc[]`	Function, method, or constructor parameter documentation.
`private`optional	`boolean`	True when the entry is marked private or matched by private filtering.
`returns`optional	`ReturnDoc`	Return value documentation for callable declarations.
`signature`optional	`string`	Full declaration signature, when the renderer can extract one.
`tags`optional	`Record<string, string>`	Additional tags preserved by tag name after known tags are normalized.
`throws`optional	`ThrowsDoc[]`	Exceptions/errors documented with `@throws` / `@exception`.

interfaceDocMemberA member belonging to a class, interface, type alias, or enum entry.16 members

A member belonging to a class, interface, type alias, or enum entry.

Signature

export interface DocMember

View source

Members

Properties

Name	Type	Description
`default`optional	`string`	Default value extracted from syntax or `@default` tags.
`description`	`string`	Main prose extracted from the member's documentation comment.
`endLine`	`number`	1-based end line of the member declaration.
`kind`	`"property" \| "method" \| "constructor" \| "getter" \| "setter" \| "enumMember"`	Normalized member kind used for rendering and sorting.
`line`	`number`	1-based start line of the member declaration.
`name`	`string`	Member name as it appears in the containing declaration.
`optional`optional	`boolean`	True when the member is optional in the source declaration.
`params`optional	`ParamDoc[]`	Parameter documentation for methods and constructors.
`private`optional	`boolean`	True when the member is marked private or matched by private filtering.
`readonly`optional	`boolean`	True when the member is declared readonly.
`returns`optional	`ReturnDoc`	Return value documentation for methods and accessors.
`signature`optional	`string`	Full member signature, when available.
`static`optional	`boolean`	True when the member is static.
`tags`optional	`Record<string, string>`	Additional tags preserved by tag name after known tags are normalized.
`throws`optional	`ThrowsDoc[]`	Exceptions/errors documented with `@throws` / `@exception`.
`type`optional	`string`	Rendered TypeScript type text for properties and enum members.

typeDocsEntryPoint = string | { path: string; name?: string }Public API entry point for grouped documentation.

Public API entry point for grouped documentation.

Signature

export type DocsEntryPoint = string | { path: string; name?: string }

View source

interfaceDocsOptionsOptions for source documentation generation. The generator extracts JSDoc/TSDoc…33 members

Options for source documentation generation.

The generator extracts JSDoc/TSDoc comments from JavaScript and TypeScript source files, normalizes the declarations, and writes Markdown plus optional navigation metadata. The defaults are optimized for documenting a package's public src tree without exposing private implementation details.

Signature

export interface DocsOptions

View source

Members

Properties

Name	Type	Description
`basePath`optional	`string`	Route prefix used by generated documentation links and nav metadata. Nav metadata falls back to `/api` when this is not set. Default `undefined`
`classPropertiesFormat`optional	`MarkdownDisplayFormat`	Display format for class property groups. Default `'none'`
`enabled`optional	`boolean`	Enable source documentation generation. The top-level `docs` option is opt-out: omitting it enables docs generation with defaults, while `docs: false` disables the docs plugin entirely. Default `true`
`entryPoints`optional	`DocsEntryPoint[]`	Public API entry points used to group re-exported docs. When omitted, docs are generated from the discovered source files without entry-point grouping. Use entry points when a package exposes a smaller public surface than its source tree. Re-exported declarations are grouped under the entry point that exposes them. Default `undefined`
`enumMembersFormat`optional	`MarkdownDisplayFormat`	Display format for enum member groups. Default `'none'`
`exclude`optional	`string[]`	Glob patterns for files to exclude. Excludes run after `include` matching and should cover tests, generated files, and implementation-only entry points. Default `['*\/.test.', '\/.spec.*', 'node_modules']`
`format`optional	`"markdown" \| "json" \| "html"`	Output format. `markdown` is the primary supported format. `json` and `html` are reserved for consumers that want to post-process extracted documentation data. Default `'markdown'`
`generateNav`optional	`boolean`	Generate navigation metadata file. Default `true`
`githubUrl`optional	`string`	GitHub repository URL for source code links. When provided, generated documentation includes links back to the source declaration lines. Default `undefined`
`groupBy`optional	`"file" \| "category"`	Group documentation by file or category. Default `'file'`
`groupOrder`optional	`string[]`	TypeDoc-style group order for module index sections and nav groups. Use `*` as the insertion point for unlisted groups. Default `undefined`
`include`optional	`string[]`	Glob patterns for files to include. Patterns are evaluated inside each `src` directory. Default `['*\/.ts', '*\/.tsx', '*\/.js', '*\/.jsx', '*\/.mts', '*\/.mjs', '*\/.cts', '*\/.cjs']`
`indexFormat`optional	`MarkdownDisplayFormat`	Display format for index items. Default `'none'`
`interfacePropertiesFormat`optional	`MarkdownDisplayFormat`	Display format for interface property groups. Default `'none'`
`internal`optional	`boolean`	Include internal members in documentation. Default `false`
`kindSortOrder`optional	`string[]`	TypeDoc-style declaration kind ranking for module sections and nav groups. Default `undefined`
`linkStyle`optional	`"markdown" \| "clean"`	Internal documentation link style. Use `markdown` for generated `.md` targets and `clean` for route-style links consumed by static-site frameworks. Default `'markdown'`
`out`optional	`string`	Output directory for generated documentation. The path is resolved from the Vite project root. Markdown pages, `docs.json`, and generated navigation metadata are written under this directory. Default `'docs/api'`
`parametersFormat`optional	`MarkdownDisplayFormat`	Display format for value and type parameters. Default `'none'`
`pathStrategy`optional	`"flat" \| "typedoc"`	Generated Markdown output path strategy. `flat` emits one page per source module or category. `typedoc` emits TypeDoc-like module, kind, and symbol pages for larger API references. Default `'flat'`
`private`optional	`boolean`	Include private members in documentation. Default `false`
`propertyMembersFormat`optional	`MarkdownDisplayFormat`	Display format for property-owned object literal members. Default `'none'`
`renderGeneratedBy`optional	`boolean`	Emit the generated-by attribution on generated root index pages. Default `true`
`renderStats`optional	`boolean`	Emit the stats summary line on generated index pages. Default `true`
`renderStyle`optional	`"html" \| "markdown"`	Rendering style for generated API Markdown. - `'html'` (default): HTML-laced Markdown with collapsible entries, stat blocks and member tables (ox-content theme). - `'markdown'`: pure Markdown (headings, tables, fenced code) with no raw HTML scaffolding, suitable for plain Markdown hosts such as VitePress. Default `'html'`
`singleEntryRoot`optional	`"preserve" \| "flatten"`	Single-entry root handling for TypeDoc-style generated docs. When set to `'flatten'`, a single TypeDoc entry point uses the root `index.md` as its landing page and omits the extra module level from generated nav metadata. Symbol page paths stay under the entry point. Default `'preserve'`
`sort`optional	`DocsSortStrategy[]`	TypeDoc-style sort strategies applied to entries and members. Strategies run in order; later strategies break ties from earlier ones. Default `undefined`
`sortEntryPoints`optional	`boolean`	Preserve caller-provided entry point order when false. Default `true`
`src`optional	`string[]`	Source directories to scan for documentation. Paths are resolved from the Vite project root before applying `include` and `exclude` patterns. Default `['./src']`
`toc`optional	`boolean`	Generate table of contents for each file. Reserved for future use; current generated API pages do not emit this TOC. Default `false`
`typeAliasPropertiesFormat`optional	`MarkdownDisplayFormat`	Display format for type alias property groups. Default `'none'`
`typeDeclarationFormat`optional	`MarkdownDisplayFormat`	Display format for return type declaration members. Default `'none'`
`typeParameters`optional	`boolean`	Opt in to TSDoc-style type-parameter documentation. When enabled, declaration type parameters (`<T extends C = D>`) are extracted into a structured "Type Parameters" section and `@typeParam` / `@template` tags are merged in (and removed from the generic tag list). `@typeParam` is a TSDoc feature, so this is off by default (JSDoc semantics). Default `false`

interfaceDocsSummarySummary counts emitted with generated documentation data.7 members

Summary counts emitted with generated documentation data.

Signature

export interface DocsSummary

View source

Members

Properties

Name	Type	Description
`byKind`	`Record<string, number>`	Entry counts grouped by normalized declaration kind.
`deprecated`	`number`	Number of entries or members marked with `@deprecated`.
`entries`	`number`	Number of top-level entries across all modules.
`examples`	`number`	Number of collected examples.
`modules`	`number`	Number of modules included in the generated payload.
`params`	`number`	Number of documented parameters.
`returns`	`number`	Number of documented return values.

interfaceDocsTestOptionsOptions for extracting fenced examples into docs-as-tests fixtures. The extract…2 members

Options for extracting fenced examples into docs-as-tests fixtures.

The extractor collects code fences that can be written into test files and executed by the exported docs test harness helpers.

Signature

export interface DocsTestOptions

View source

Members

Properties

Name	Type	Description
`languages`optional	`string[]`	Fence languages to collect as runnable examples. Language names are compared case-insensitively. Default `['js', 'jsx', 'ts', 'tsx']`
`requireMeta`optional	`boolean`	Require an opt-in fence meta marker before collecting an example. When enabled, only fences marked with metadata such as `test`, `runnable`, `vitest`, or `docs-test` are collected. Default `true`

interfaceEditThisPageOptionsOptions for appending an "edit this page" link. The generated link points at th…4 members

Options for appending an "edit this page" link.

The generated link points at the source Markdown file rather than the emitted HTML route. Configure branch and rootDir to match the repository layout users should edit.

Signature

export interface EditThisPageOptions

View source

Members

Properties

Name	Type	Description
`branch`optional	`string`	Branch used in generated edit links. Use the branch that accepts documentation changes, not necessarily the branch that produced the deployed site. Default `'main'`
`label`optional	`string`	Link text rendered in the page footer. Keep this short; the default theme renders it as a compact footer action. Default `'Edit this page'`
`repoUrl`	`string`	Repository URL used to build edit links. The transform is enabled only when this value is provided.
`rootDir`optional	`string`	Source root inside the repository, used before the page path. Set this when `srcDir` is nested in a package or docs workspace. Default `undefined`

interfaceEmojiShortcodeOptionsOptions for expanding :shortcode: emoji aliases. The transform replaces recogni…1 member

Options for expanding :shortcode: emoji aliases.

The transform replaces recognized shortcode tokens with their Unicode emoji equivalents during Markdown transformation. Unknown shortcodes are left untouched so colon-delimited text can still be used by other tools.

Signature

export interface EmojiShortcodeOptions

View source

Members

Properties

Name	Type	Description
`custom`optional	`Record<string, string>`	Custom shortcode map merged with the built-in emoji aliases. Keys should omit the surrounding colons. Default `{}`

interfaceEntryPageConfigEntry page frontmatter configuration.3 members

Entry page frontmatter configuration.

Signature

export interface EntryPageConfig

View source

Members

Properties

Name	Type	Description
`features`optional	`FeatureConfig[]`	Feature cards
`hero`optional	`HeroConfig`	Hero section
`layout`	`"entry"`	Layout type - set to 'entry' for entry page

interfaceExtractedDocsExtracted documentation for a single file.6 members

Extracted documentation for a single file.

Signature

export interface ExtractedDocs

View source

Members

Properties

Name	Type	Description
`description`optional	`string`	Optional module-level description extracted from a file header comment.
`entries`	`DocEntry[]`	Top-level documented declarations found in this module.
`examples`optional	`string[]`	Module-level examples collected from a file header comment.
`file`	`string`	Source module or file identifier used by generated output.
`sourcePath`optional	`string`	Absolute source path, when available for source links and diagnostics.
`tags`optional	`Record<string, string>`	Module-level tags preserved by tag name.

interfaceFeatureConfigFeature card for entry page.5 members

Feature card for entry page.

Signature

export interface FeatureConfig

View source

Members

Properties

Name	Type	Description
`details`optional	`string`	Feature description
`icon`optional	`string`	Icon - supports: "mdi:icon-name" (Iconify), image URL, or emoji
`link`optional	`string`	Optional link
`linkText`optional	`string`	Link text
`title`	`string`	Feature title

interfaceGeneratedDocsDataMachine-readable payload emitted alongside generated docs.4 members

Machine-readable payload emitted alongside generated docs.

Signature

export interface GeneratedDocsData

View source

Members

Properties

Name	Type	Description
`generatedAt`	`string`	ISO timestamp for the generation run.
`modules`	`ExtractedDocs[]`	Extracted documentation modules in render order.
`summary`	`DocsSummary`	Aggregate counts useful for dashboards and generated index pages.
`version`	`1`	Payload schema version. Increment when the JSON shape changes incompatibly.

interfaceHeroActionHero section action button.3 members

Hero section action button.

Signature

export interface HeroAction

View source

Members

Properties

Name	Type	Description
`link`	`string`	Link URL
`text`	`string`	Button text
`theme`optional	`"brand" \| "alt"`	Button theme: 'brand' (primary) or 'alt' (secondary)

interfaceHeroConfigHero section configuration for entry page.6 members

Hero section configuration for entry page.

Signature

export interface HeroConfig

View source

Members

Properties

Name	Type	Description
`actions`optional	`HeroAction[]`	Action buttons
`image`optional	`HeroImage`	Hero image
`name`optional	`string`	Main title (large, gradient text)
`notice`optional	`HeroNotice`	Notice shown near the top of the hero
`tagline`optional	`string`	Tagline (smaller, muted)
`text`optional	`string`	Secondary text (medium size)

interfaceHeroImageHero section image configuration.6 members

Hero section image configuration.

Signature

export interface HeroImage

View source

Members

Properties

Name	Type	Description
`alt`optional	`string`	Alt text
`darkSrc`optional	`string`	Dark mode image source URL
`height`optional	`number`	Image height
`lightSrc`optional	`string`	Light mode image source URL
`src`	`string`	Image source URL
`width`optional	`number`	Image width

interfaceHeroNoticeHero notice configuration.2 members

Hero notice configuration.

Signature

export interface HeroNotice

View source

Members

Properties

Name	Type	Description
`body`optional	`string[]`	Notice paragraphs
`title`optional	`string`	Notice title

interfaceI18nOptionsi18n (internationalization) options. i18n is opt-in because it changes routing…7 members

i18n (internationalization) options.

i18n is opt-in because it changes routing and build-time validation. Set enabled: true and configure at least defaultLocale / locales when the same content tree should serve multiple languages.

Signature

export interface I18nOptions

View source

Members

Properties

Name	Type	Description
`check`optional	`boolean`	Run i18n checks during build. Checks validate dictionary coverage and translation function usage when the native i18n checker is available. Default `true`
`defaultLocale`optional	`string`	Default locale tag. The default locale is added to `locales` automatically when omitted from the list. Default `'en'`
`dir`optional	`string`	Path to i18n dictionary directory (relative to project root). Dictionary files are watched in development and checked during builds when `check` is enabled. Default `'content/i18n'`
`enabled`optional	`boolean`	Enable i18n. The resolver returns `false` unless this is explicitly set to `true`. Default `false`
`functionNames`optional	`string[]`	Translation function names to detect in source code. Add framework-specific wrappers here so build-time checks can find all translation keys. Default `['t', '$t']`
`hideDefaultLocale`optional	`boolean`	Hide default locale prefix in URLs. When true, `/page` serves the default locale and `/ja/page` serves Japanese. When false, all locales get prefixed: `/en/page`, `/ja/page`. Default `true`
`locales`optional	`LocaleConfig[]`	Available locales. When omitted, ox-content creates a single locale from `defaultLocale`. Default `[{ code: defaultLocale, name: defaultLocale }]`

interfaceLocaleConfigLocale configuration. Locales define the routing and display metadata used by t…3 members

Locale configuration.

Locales define the routing and display metadata used by the i18n plugin.

Signature

export interface LocaleConfig

View source

Members

Properties

Name	Type	Description
`code`	`string`	BCP 47 locale tag (e.g., 'en', 'ja', 'zh-Hans').
`dir`optional	`"ltr" \| "rtl"`	Text direction for rendered pages. Default `'ltr'`
`name`	`string`	Display name for this locale (e.g., 'English', '日本語').

interfaceMarkdownNodeMarkdown AST node (simplified for TypeScript).4 members

Markdown AST node (simplified for TypeScript).

Signature

export interface MarkdownNode

View source

Members

Indexable

[key: string]: unknown

Properties

Name	Type	Description
`children`optional	`MarkdownNode[]`
`type`	`string`
`value`optional	`string`

interfaceMarkdownTransformerCustom AST transformer.2 members

Custom AST transformer.

Signature

export interface MarkdownTransformer

View source

Members

Properties

Name	Type	Description
`name`	`string`	Transformer name.
`transform`	`(ast: MarkdownNode, context: TransformContext) => MarkdownNode \| Promise<MarkdownNode>`	Transform function. `ast` `context`

interfaceNavItemNavigation item for sidebar navigation.3 members

Navigation item for sidebar navigation.

Signature

export interface NavItem

View source

Members

Properties

Name	Type	Description
`children`optional	`NavItem[]`	Child navigation items (optional).
`path`	`string`	Path to the documentation page.
`title`	`string`	Display title for the navigation item.

interfaceOgImageOptionsOG image generation options. Uses Chromium-based rendering with customizable te…6 members

OG image generation options. Uses Chromium-based rendering with customizable templates.

Signature

export interface OgImageOptions

View source

Members

Properties

Name	Type	Description
`cache`optional	`boolean`	Enable content-hash based caching. Skips rendering when content hasn't changed. Default `true`
`concurrency`optional	`number`	Number of concurrent page instances for parallel rendering. Default `1`
`height`optional	`number`	Image height in pixels. Default `630`
`template`optional	`string`	Path to a custom template file (.ts, .vue, .svelte, .tsx/.jsx). - `.ts`: default-export a function `(props) => string` - `.vue`: Vue SFC, rendered via SSR - `.svelte`: Svelte SFC, rendered via SSR - `.tsx`/`.jsx`: React Server Component, rendered via SSR If not specified, the built-in default template is used.
`vuePlugin`optional	`"vitejs" \| "vizejs"`	Vue plugin to use for compiling `.vue` templates. - `'vitejs'`: Use `@vue/compiler-sfc` (official, default) - `'vizejs'`: Use `@vizejs/vite-plugin` (Rust-based) Default `'vitejs'`
`width`optional	`number`	Image width in pixels. Default `1200`

interfaceOxContentOptionsOptions for the core oxContent() Vite plugin. The top-level options describe wh…38 members

Options for the core oxContent() Vite plugin.

The top-level options describe where content lives, which Markdown features are enabled, and which build-time features should run. Feature toggles that accept boolean | Options follow the same convention:

false disables the feature.
true enables the feature with its documented defaults.
an object enables the feature and overrides only the provided fields.

Signature

export interface OxContentOptions

View source

Members

Properties

Name	Type	Description
`attrs`optional	`boolean \| AttrsOptions`	Enable markdown-it-attrs style `{#id .class key=value}` attributes. Attribute blocks can be attached to headings, paragraphs, links, images, and other supported Markdown nodes depending on parser context. Default `false`
`autolinks`optional	`boolean`	Enable GFM autolinks and linkify bare URLs. Default `true`
`base`optional	`string`	Base path prepended to generated internal URLs. Use this when the site is deployed below a sub-path, such as GitHub Pages or a documentation route inside a larger application. Default `'/'`
`cjkEmphasis`optional	`boolean`	Recognize emphasis adjacent to CJK text. The native parser already supports this behavior; the option documents the compatibility contract. Default `false`
`codeAnnotations`optional	`boolean \| CodeAnnotationsOptions`	Code block line annotations for fenced code blocks. This feature is opt-in because it changes rendered code-block markup. Pass `true` to enable ox-content's attribute syntax, or pass an options object to change the meta key or enable VitePress-compatible notation. Default `false`
`codeBlockLint`optional	`boolean \| CodeBlockLintOptions`	Lint fenced code blocks during Markdown transforms. Use this as a lightweight authoring check for missing languages or trailing whitespace inside fences. For project-wide linting, prefer the exported `lintCodeBlocks()` helper or the Markdown lint APIs. Default `false`
`codeBlockTypecheck`optional	`boolean \| CodeBlockTypecheckOptions`	Type-check TypeScript/TSX code fences via tsgo. By default only fences with explicit opt-in metadata are checked. This keeps incidental examples cheap while allowing docs-as-code snippets to fail the build when configured with `mode: 'error'`. Default `false`
`codeImports`optional	`boolean \| CodeImportOptions`	Import source snippets into fences with `<<< @/path/to/file.ts{region}`. This is useful for documentation that must stay synchronized with examples in the repository. Use `rootDir` when snippets should resolve from a directory other than the Vite project root. Default `false`
`collections`optional	`CollectionsOptions \| boolean`	Markdown collection query options. Collections are exposed through `virtual:ox-content/collections`. The default collection is metadata-only and is built by the native Rust manifest builder without rendering every document; add `include` fields only for routes that need raw or rendered content in the query payload. Default `content collection for all Markdown files`
`docs`optional	`DocsOptions \| false`	Source documentation generation options. Set to false to disable (opt-out). Default `{ enabled: true }`
`docsTests`optional	`boolean \| DocsTestOptions`	Extract runnable fenced examples for Vitest docs-as-tests harnesses. Collected examples can be written by the docs test helpers and executed as part of a normal Vitest suite. Default `false`
`editThisPage`optional	`boolean \| EditThisPageOptions`	Append an "edit this page" link to rendered Markdown. The feature is enabled only when `repoUrl` is provided in the options object. Passing `true` keeps the feature disabled because there is not enough repository information to generate valid links. Default `false`
`embeds`optional	`BuiltinEmbedOptions \| false`	Built-in static embeds rendered during Markdown transformation. Set to `false` to disable all built-in embeds. Default `{ github: true, openGraph: true }`
`emojiShortcodes`optional	`boolean \| EmojiShortcodeOptions`	Expand `:shortcode:` emoji aliases to Unicode. Built-in aliases cover common emoji names. Provide `custom` entries for project-specific aliases or to override a built-in mapping. Default `false`
`extensions`optional	`string[]`	Markdown-like file extensions to process. Extensions are normalized with a leading dot and matched case-insensitively. Add custom extensions when another authoring format is compiled to Markdown before ox-content sees it. Default `['.md', '.markdown', '.mdx']`
`footnotes`optional	`boolean`	Enable footnotes. Default `true`
`frontmatter`optional	`boolean`	Parse YAML frontmatter. Default `true`
`gfm`optional	`boolean`	Enable GitHub Flavored Markdown extensions. Default `true`
`highlight`optional	`boolean`	Enable syntax highlighting for code blocks. Default `false`
`highlightLangs`optional	`LanguageRegistration[]`	Additional languages for syntax highlighting. Accepts Shiki LanguageRegistration objects (e.g., TextMate grammars). These are loaded alongside the built-in languages. Default `[]`
`highlightTheme`optional	`string \| ThemeRegistration`	Syntax highlighting theme. Default `'github-dark'`
`i18n`optional	`I18nOptions \| false`	i18n (internationalization) options. Set to false to disable i18n. Default `false`
`mermaid`optional	`boolean`	Enable mermaid diagram rendering. Default `false`
`ogImage`optional	`boolean`	Enable OG image generation. Default `false`
`ogImageOptions`optional	`OgImageOptions`	OG image generation options. Ignored unless `ogImage` or `ssg.generateOgImage` is enabled. Default `{ vuePlugin: 'vitejs', width: 1200, height: 630, cache: true, concurrency: 1 }`
`ogViewer`optional	`boolean`	Enable OG Viewer dev tool. Accessible at /__og-viewer during development. Default `true`
`outDir`optional	`string`	Directory where generated files are written. SSG HTML, search indexes, and generated assets are emitted under this directory during production builds. Default `'dist'`
`sanitize`optional	`boolean \| SanitizeOptions`	Sanitize rendered HTML with safe defaults or explicit allow lists. Enable this for untrusted Markdown. The default allow lists are conservative; pass an options object only when the content model intentionally needs extra tags, attributes, or URL schemes. Default `false`
`search`optional	`SearchOptions \| boolean`	Full-text search options. Set to false to disable search. Default `{ enabled: true }`
`srcDir`optional	`string`	Directory containing Markdown source files. The path is resolved from the Vite project root. SSG, search indexing, and dev-server routing all use this directory as the content root. Default `'content'`
`ssg`optional	`SsgOptions \| boolean`	Static Site Generation options. Passing `true` or omitting this option enables SSG with defaults. Passing `false` disables the SSG plugin while still allowing Markdown module transforms to run. Default `{ enabled: true }`
`strikethrough`optional	`boolean`	Enable strikethrough. Default `true`
`tables`optional	`boolean`	Enable tables. Default `true`
`taskLists`optional	`boolean`	Enable task lists. Default `true`
`toc`optional	`boolean`	Generate table of contents. Default `true`
`tocMaxDepth`optional	`number`	Maximum heading depth for TOC. Default `3`
`transformers`optional	`MarkdownTransformer[]`	Custom AST transformers. Transformers run after parsing and before the final JavaScript module is emitted. Default `[]`
`wikiLinks`optional	`boolean \| WikiLinkOptions`	Expand Obsidian-style `[[page]]` and `[[page\|label]]` links. Use this for knowledge-base style content where authors prefer short, document-relative link syntax. Pass an object to override the base URL used when resolving generated hrefs. Default `false`

interfaceParamDocParameter documentation.5 members

Parameter documentation.

Signature

export interface ParamDoc

View source

Members

Properties

Name	Type	Description
`default`optional	`string`	Default value extracted from syntax or `@default` tags.
`description`	`string`	Prose extracted from `@param` / `@arg` documentation.
`name`	`string`	Parameter name, including dotted names for destructured properties.
`optional`optional	`boolean`	True when the parameter is optional.
`type`	`string`	Rendered TypeScript type text.

interfaceResolvedAttrsOptionsResolved attrs transform options.1 member

Resolved attrs transform options.

Signature

export interface ResolvedAttrsOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`

interfaceResolvedBuiltinEmbedOptionsResolved built-in embed configuration.8 members

Resolved built-in embed configuration.

Signature

export interface ResolvedBuiltinEmbedOptions

View source

Members

Properties

Name	Type	Description
`bluesky`	`boolean`
`github`	`GitHubOptions \| false`
`openGraph`	`OgpOptions \| false`
`pm`	`BuiltinPmOptions \| false`
`spotify`	`boolean`
`stackBlitz`	`boolean`
`twitter`	`TwitterEmbedOptions \| false`
`webContainer`	`boolean`

interfaceResolvedCodeAnnotationsOptionsResolved code annotation configuration.4 members

Resolved code annotation configuration.

Signature

export interface ResolvedCodeAnnotationsOptions

View source

Members

Properties

Name	Type	Description
`defaultLineNumbers`	`boolean`
`enabled`	`boolean`
`metaKey`	`string`
`notation`	`CodeAnnotationSyntax`

interfaceResolvedCodeBlockLintOptionsResolved code-block lint options.5 members

Resolved code-block lint options.

Signature

export interface ResolvedCodeBlockLintOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`languages`optional	`string[]`
`mode`	`"warn" \| "error"`
`requireLanguage`	`boolean`
`trailingSpaces`	`boolean`

interfaceResolvedCodeBlockTypecheckOptionsResolved code-block type-check options.5 members

Resolved code-block type-check options.

Signature

export interface ResolvedCodeBlockTypecheckOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`languages`	`string[]`
`mode`	`"warn" \| "error"`
`requireMeta`	`boolean`
`tsgoCommand`	`string`

interfaceResolvedCodeImportOptionsResolved code-import transform options.2 members

Resolved code-import transform options.

Signature

export interface ResolvedCodeImportOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`rootDir`optional	`string`

interfaceResolvedCollectionOptionsResolved collection definition.3 members

Resolved collection definition.

Signature

export interface ResolvedCollectionOptions

View source

Members

Properties

Name	Type	Description
`include`	`CollectionIncludeField[]`
`name`	`string`
`source`	`string[]`

interfaceResolvedCollectionsOptionsResolved collection options.2 members

Resolved collection options.

Signature

export interface ResolvedCollectionsOptions

View source

Members

Properties

Name	Type	Description
`collections`	`Record<string, ResolvedCollectionOptions>`
`enabled`	`boolean`

interfaceResolvedDocsEntryPointResolved public API entry point.2 members

Resolved public API entry point.

Signature

export interface ResolvedDocsEntryPoint

View source

Members

Properties

Name	Type	Description
`name`optional	`string`
`path`	`string`

interfaceResolvedDocsOptionsResolved docs options with all defaults applied.33 members

Resolved docs options with all defaults applied.

Signature

export interface ResolvedDocsOptions

View source

Members

Properties

Name	Type	Description
`basePath`optional	`string`
`classPropertiesFormat`	`MarkdownDisplayFormat`
`enabled`	`boolean`
`entryPoints`optional	`ResolvedDocsEntryPoint[]`
`enumMembersFormat`	`MarkdownDisplayFormat`
`exclude`	`string[]`
`format`	`"markdown" \| "json" \| "html"`
`generateNav`	`boolean`
`githubUrl`optional	`string`
`groupBy`	`"file" \| "category"`
`groupOrder`optional	`string[]`
`include`	`string[]`
`indexFormat`	`MarkdownDisplayFormat`
`interfacePropertiesFormat`	`MarkdownDisplayFormat`
`internal`	`boolean`
`kindSortOrder`optional	`string[]`
`linkStyle`	`"markdown" \| "clean"`
`out`	`string`
`parametersFormat`	`MarkdownDisplayFormat`
`pathStrategy`	`"flat" \| "typedoc"`
`private`	`boolean`
`propertyMembersFormat`	`MarkdownDisplayFormat`
`renderGeneratedBy`	`boolean`
`renderStats`	`boolean`
`renderStyle`	`"html" \| "markdown"`
`singleEntryRoot`	`"preserve" \| "flatten"`
`sort`optional	`DocsSortStrategy[]`
`sortEntryPoints`	`boolean`
`src`	`string[]`
`toc`	`boolean`
`typeAliasPropertiesFormat`	`MarkdownDisplayFormat`
`typeDeclarationFormat`	`MarkdownDisplayFormat`
`typeParameters`	`boolean`

interfaceResolvedDocsTestOptionsResolved docs-as-tests extraction options.3 members

Resolved docs-as-tests extraction options.

Signature

export interface ResolvedDocsTestOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`languages`	`string[]`
`requireMeta`	`boolean`

interfaceResolvedEditThisPageOptionsResolved edit-link transform options.5 members

Resolved edit-link transform options.

Signature

export interface ResolvedEditThisPageOptions

View source

Members

Properties

Name	Type	Description
`branch`	`string`
`enabled`	`boolean`
`label`	`string`
`repoUrl`optional	`string`
`rootDir`optional	`string`

interfaceResolvedEmojiShortcodeOptionsResolved emoji-shortcode transform options.2 members

Resolved emoji-shortcode transform options.

Signature

export interface ResolvedEmojiShortcodeOptions

View source

Members

Properties

Name	Type	Description
`custom`	`Record<string, string>`
`enabled`	`boolean`

interfaceResolvedI18nOptionsResolved i18n options with all defaults applied.7 members

Resolved i18n options with all defaults applied.

Signature

export interface ResolvedI18nOptions

View source

Members

Properties

Name	Type	Description
`check`	`boolean`
`defaultLocale`	`string`
`dir`	`string`
`enabled`	`boolean`
`functionNames`	`string[]`
`hideDefaultLocale`	`boolean`
`locales`	`LocaleConfig[]`

interfaceResolvedOgImageOptionsResolved OG image options with all defaults applied.6 members

Resolved OG image options with all defaults applied.

Signature

export interface ResolvedOgImageOptions

View source

Members

Properties

Name	Type	Description
`cache`	`boolean`
`concurrency`	`number`
`height`	`number`
`template`optional	`string`
`vuePlugin`	`"vitejs" \| "vizejs"`
`width`	`number`

interfaceResolvedOptionsResolved options with all defaults applied.38 members

Resolved options with all defaults applied.

Signature

export interface ResolvedOptions

View source

Members

Properties

Name	Type	Description
`attrs`	`ResolvedAttrsOptions`
`autolinks`	`boolean`
`base`	`string`
`cjkEmphasis`	`boolean`
`codeAnnotations`	`ResolvedCodeAnnotationsOptions`
`codeBlockLint`	`ResolvedCodeBlockLintOptions`
`codeBlockTypecheck`	`ResolvedCodeBlockTypecheckOptions`
`codeImports`	`ResolvedCodeImportOptions`
`collections`	`ResolvedCollectionsOptions`
`docs`	`ResolvedDocsOptions \| false`
`docsTests`	`ResolvedDocsTestOptions`
`editThisPage`	`ResolvedEditThisPageOptions`
`embeds`	`ResolvedBuiltinEmbedOptions`
`emojiShortcodes`	`ResolvedEmojiShortcodeOptions`
`extensions`	`string[]`
`footnotes`	`boolean`
`frontmatter`	`boolean`
`gfm`	`boolean`
`highlight`	`boolean`
`highlightLangs`	`LanguageRegistration[]`
`highlightTheme`	`string \| ThemeRegistration`
`i18n`	`ResolvedI18nOptions \| false`
`mermaid`	`boolean`
`ogImage`	`boolean`
`ogImageOptions`	`ResolvedOgImageOptions`
`ogViewer`	`boolean`
`outDir`	`string`
`sanitize`	`ResolvedSanitizeOptions`
`search`	`ResolvedSearchOptions`
`srcDir`	`string`
`ssg`	`ResolvedSsgOptions`
`strikethrough`	`boolean`
`tables`	`boolean`
`taskLists`	`boolean`
`toc`	`boolean`
`tocMaxDepth`	`number`
`transformers`	`MarkdownTransformer[]`
`wikiLinks`	`ResolvedWikiLinkOptions`

interfaceResolvedSanitizeOptionsResolved sanitize transform options.4 members

Resolved sanitize transform options.

Signature

export interface ResolvedSanitizeOptions

View source

Members

Properties

Name	Type	Description
`allowedAttributes`optional	`string[]`
`allowedTags`optional	`string[]`
`allowedUrlSchemes`optional	`string[]`
`enabled`	`boolean`

interfaceResolvedSearchOptionsResolved search options.5 members

Resolved search options.

Signature

export interface ResolvedSearchOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`hotkey`	`string`
`limit`	`number`
`placeholder`	`string`
`prefix`	`boolean`

interfaceResolvedSsgOptionsResolved SSG options.11 members

Resolved SSG options.

Signature

export interface ResolvedSsgOptions

View source

Members

Properties

Name	Type	Description
`bare`	`boolean`
`clean`	`boolean`
`enabled`	`boolean`
`extension`	`string`
`generateOgImage`	`boolean`
`lastUpdated`	`boolean`
`navigation`optional	`SsgNavigationGroup[]`
`ogImage`optional	`string`
`siteName`optional	`string`
`siteUrl`optional	`string`
`theme`optional	`ResolvedThemeConfig`

interfaceResolvedWikiLinkOptionsResolved wiki-link transform options.2 members

Resolved wiki-link transform options.

Signature

export interface ResolvedWikiLinkOptions

View source

Members

Properties

Name	Type	Description
`baseUrl`	`string`
`enabled`	`boolean`

interfaceReturnDocReturn type documentation.2 members

Return type documentation.

Signature

export interface ReturnDoc

View source

Members

Properties

Name	Type	Description
`description`	`string`	Prose extracted from `@returns` / `@return` documentation.
`type`	`string`	Rendered TypeScript type text for the return value.

interfaceSanitizeOptionsOptions for sanitizing rendered HTML. Sanitization happens after Markdown is re…3 members

Options for sanitizing rendered HTML.

Sanitization happens after Markdown is rendered to HTML. This makes it useful for user-authored content, but consumers should avoid enabling extra tags or schemes unless the rendered output explicitly requires them.

Signature

export interface SanitizeOptions

View source

Members

Properties

Name	Type	Description
`allowedAttributes`optional	`string[]`	Allowed HTML attribute names. Omit to use the built-in safe attribute allow list. Provide a full replacement list, not a list of additions. Default `undefined`
`allowedTags`optional	`string[]`	Allowed HTML tag names. Omit to use the built-in safe tag allow list. Provide a full replacement list, not a list of additions. Default `undefined`
`allowedUrlSchemes`optional	`string[]`	Allowed URL schemes for link-like attributes. Omit to use the built-in safe scheme allow list. Default `undefined`

interfaceScopedSearchQueryParsed search query with optional scope prefixes.2 members

Parsed search query with optional scope prefixes.

Signature

export interface ScopedSearchQuery

View source

Members

Properties

Name	Type	Description
`scopes`	`string[]`	Deduplicated lowercase scope prefixes requested by the query.
`text`	`string`	Query text after `@scope` prefixes have been removed.

interfaceSearchDocumentSearch document structure.6 members

Search document structure.

Signature

export interface SearchDocument

View source

Members

Properties

Name	Type	Description
`body`	`string`	Plain-text body content used for scoring and snippets.
`code`	`string[]`	Code block text extracted from the document.
`headings`	`string[]`	Headings extracted from the document.
`id`	`string`	Stable document identifier used by the search index.
`title`	`string`	Human-readable document title.
`url`	`string`	URL returned to search consumers.

interfaceSearchOptionsOptions for full-text search. Search indexes are built from Markdown content at…5 members

Options for full-text search.

Search indexes are built from Markdown content at build time and loaded by the client runtime from search-index.json. Pass false to the top-level search option to disable both index generation and the virtual search module.

Signature

export interface SearchOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable search functionality. Set this to `false` when config merging requires an object shape but search should be disabled. Default `true`
`hotkey`optional	`string`	Keyboard shortcut to focus search (without modifier). Use an empty string to let the UI opt out of registering a shortcut. Default `'/'`
`limit`optional	`number`	Maximum number of search results. This controls client-side result truncation, not the number of documents in the generated index. Default `10`
`placeholder`optional	`string`	Placeholder text for the search input. This value is embedded in the virtual search module for UI consumers. Default `'Search documentation...'`
`prefix`optional	`boolean`	Enable prefix matching for autocomplete. Prefix matching applies to the final query token, which keeps normal terms precise while still supporting typeahead-style interactions. Default `true`

interfaceSearchResultSearch result structure.7 members

Search result structure.

Signature

export interface SearchResult

View source

Members

Properties

Name	Type	Description
`id`	`string`	Matching document identifier.
`matches`	`string[]`	Query terms that matched the document.
`scopes`optional	`string[]`	Hierarchical scopes derived from the result URL or document id.
`score`	`number`	Relevance score returned by the BM25 search engine.
`snippet`	`string`	Context snippet with highlighted terms when available.
`title`	`string`	Matching document title.
`url`	`string`	URL to open when the result is selected.

interfaceSsgNavigationGroupNavigation group for SSG sidebar rendering.2 members

Navigation group for SSG sidebar rendering.

Signature

export interface SsgNavigationGroup

View source

Members

Properties

Name	Type	Description
`items`	`SsgNavigationItem[]`	Navigation items within this group
`title`	`string`	Group heading

interfaceSsgNavigationItemNavigation item for SSG sidebar rendering.3 members

Navigation item for SSG sidebar rendering.

Signature

export interface SsgNavigationItem

View source

Members

Properties

Name	Type	Description
`href`optional	`string`	Final href used in the rendered HTML. When omitted for internal links, ox-content derives it from `path`.
`path`optional	`string`	Route path used for active-state matching. Internal links should use site-relative paths such as `/getting-started`.
`title`	`string`	Display title

interfaceSsgOptionsStatic Site Generation options. These options control the HTML files emitted at…11 members

Static Site Generation options.

These options control the HTML files emitted at build time and the matching dev-server preview behavior. Pass false to the top-level ssg option to disable the whole SSG pipeline, or pass an object to customize the defaults.

Signature

export interface SsgOptions

View source

Members

Properties

Name	Type	Description
`bare`optional	`boolean`	Emit bare HTML with only the rendered Markdown body. This skips the default navigation, layout shell, and theme styles. It is mainly useful for benchmarking, fixture generation, or projects that wrap the output in their own shell. Default `false`
`clean`optional	`boolean`	Remove previously generated files from the output directory before writing the new SSG result. Leave this disabled when the output directory also contains assets produced by other Vite plugins or external build steps. Default `false`
`enabled`optional	`boolean`	Enable the SSG pipeline. Keep this enabled when ox-content owns page rendering. Disable it only when another framework integration will consume the Markdown modules directly. Default `true`
`extension`optional	`string`	File extension used for generated routes. The value should include the leading dot. For example, `.html` emits `guide.html`, while an empty string can be used by custom deployments that map extensionless output themselves. Default `'.html'`
`generateOgImage`optional	`boolean`	Generate one Open Graph image per page. Generated images are written alongside the SSG output and referenced from each page's metadata. Configure rendering details with the top-level `ogImageOptions` option. Default `false`
`lastUpdated`optional	`boolean`	Add each page's last git commit timestamp to the default theme. Default `false`
`navigation`optional	`SsgNavigationGroup[]`	Sidebar navigation override. When omitted, ox-content derives navigation from the Markdown file tree. Provide this when migrating from systems such as VitePress where navigation is intentionally hand-authored. Default `undefined`
`ogImage`optional	`string`	Static Open Graph image URL used for social sharing. When `generateOgImage` is enabled, this value is still useful as a fallback for pages that cannot produce a generated image. Default `undefined`
`siteName`optional	`string`	Site name shown in the default theme header and title suffix. When omitted, the renderer falls back to project metadata where available. Default `undefined`
`siteUrl`optional	`string`	Absolute site URL used when generating social metadata. Set this when pages need absolute Open Graph image URLs. Include the origin and any deployment base path, without a trailing page path. Default `undefined`
`theme`optional	`ThemeConfig`	Theme configuration for generated pages. Use `defineTheme()` to build this object so custom theme modules and the default theme extension points keep their expected shape. Default `defaultTheme`

interfaceThrowsDocException/error documentation.2 members

Exception/error documentation.

Signature

export interface ThrowsDoc

View source

Members

Properties

Name	Type	Description
`description`	`string`	Prose extracted from `@throws` / `@exception` documentation.
`type`optional	`string`	Rendered TypeScript type text for the thrown value, when documented.

interfaceTocEntryTable of contents entry.4 members

Table of contents entry.

Signature

export interface TocEntry

View source

Members

Properties

Name	Type	Description
`children`	`TocEntry[]`	Child entries.
`depth`	`number`	Heading depth (1-6).
`slug`	`string`	Slug/ID for linking.
`text`	`string`	Heading text.

interfaceTransformContextTransform context passed to transformers.3 members

Transform context passed to transformers.

Signature

export interface TransformContext

View source

Members

Properties

Name	Type	Description
`filePath`	`string`	File path being processed.
`frontmatter`	`Record<string, unknown>`	Frontmatter data.
`options`	`ResolvedOptions`	Resolved plugin options.

interfaceTransformResultTransform result.5 members

Transform result.

Signature

export interface TransformResult

View source

Members

Properties

Name	Type	Description
`code`	`string`	Generated JavaScript code.
`frontmatter`	`Record<string, unknown>`	Parsed frontmatter.
`html`	`string`	Rendered HTML.
`map`optional	`null`	Source map (null means no source map).
`toc`	`TocEntry[]`	Table of contents.

moduletypesType definitions for @ox-content/vite-plugin

Type definitions for @ox-content/vite-plugin

View source

interfaceWikiLinkOptionsOptions for expanding Obsidian-style wiki links. The transform accepts [target]…1 member

Options for expanding Obsidian-style wiki links.

The transform accepts [[target]] and [[target|label]] syntax and rewrites it to regular links before rendering. It is intentionally small: path resolution is based on the configured base URL rather than a full backlink graph.

Signature

export interface WikiLinkOptions

View source

Members

Properties

Name	Type	Description
`baseUrl`optional	`string`	Base URL prepended to resolved wiki-link targets. When omitted, the top-level `base` option is used. Default `options.base`