types.ts#

View Markdown

Source

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

193 symbols 170 interfaces 22 types 1 modules 953 members

Reference#

interfaceA11yOptionsPer-control flags for ssg.a11y. Omitted fields keep the defaults when the featu…1 member

Per-control flags for ssg.a11y.

Omitted fields keep the defaults when the feature itself is enabled.

Signature

export interface A11yOptions

View source

Members

Properties

Name	Type	Description
`skipLinkLabel`optional	`string`	Visible label for the skip link. Escaped in HTML. Default `"Skip to content"`

interfaceAbbreviationsOptionsOptions for opt-in abbreviation and glossary expansion.3 members

Options for opt-in abbreviation and glossary expansion.

Signature

export interface AbbreviationsOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable the transform when an options object is supplied. Default `true`
`firstUseOnly`optional	`boolean`	Wrap only the first occurrence of each term. Default `false`
`terms`optional	`Record<string, string>`	Central glossary. Keys are matched with Unicode word boundaries.

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`

interfaceBadgeOptionsOptions for opt-in {badge:variant} inline badges.1 member

Options for opt-in {badge:variant} inline badges.

Signature

export interface BadgeOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable the badge transform when an options object is supplied. Default `true`

interfaceBlogAuthorOne person in the blog.authors map.3 members

One person in the blog.authors map.

Signature

export interface BlogAuthor

View source

Members

Properties

Name	Type	Description
`bio`optional	`string`	Optional short bio. Escaped in HTML.
`name`	`string`	Display name. Escaped in HTML.
`url`optional	`string`	Profile URL. Only `https:` or a site-relative `/` path is emitted.

typeBlogFeedFailurePolicy = "warn" | "error"How a failed external feed source is reported.

How a failed external feed source is reported.

Signature

export type BlogFeedFailurePolicy = "warn" | "error"

View source

interfaceBlogFeedSourceOne configured external blog feed.4 members

One configured external blog feed.

Signature

export interface BlogFeedSource

View source

Members

Properties

Name	Type	Description
`author`optional	`string`	Default author applied when an item omits one.
`language`optional	`string`	Default language applied when an item omits one.
`onError`optional	`BlogFeedFailurePolicy`	Failed fetch / parse handling for this source. `warn` skips the source. `error` fails the build after other sources run. Default `"warn"`
`url`	`string`	Absolute `https:` feed URL.

interfaceBlogOptionsOpt-in blog index, authors, tags, reading time, and archive.4 members

Opt-in blog index, authors, tags, reading time, and archive.

Signature

export interface BlogOptions

View source

Members

Properties

Name	Type	Description
`authors`optional	`Record<string, BlogAuthor>`	Author records keyed by the frontmatter `author` / `authors` value. Default `{}`
`collection`optional	`string`	Named collection of posts. Defaults to a collection named `blog`, or the only configured collection. Required when several collections exist and none is named `blog`.
`feeds`optional	`Array<string \| BlogFeedSource>`	External RSS / Atom sources merged into the blog index at build time. Empty / omitted fetches nothing. Only these URLs are requested. Default `[]`
`pageSize`optional	`number`	Posts per index page, newest first. Default `10`

interfaceBuiltinEmbedOptionsBuilt-in embed configuration.30 members

Built-in embed configuration.

Signature

export interface BuiltinEmbedOptions

View source

Members

Properties

Name	Type	Description
`appleMusic`optional	`boolean`	Render `<AppleMusic url="https://music.apple.com/...">` iframes. Default `false`
`asciinema`optional	`boolean`	Render `<Asciinema>` terminal-recording cards. Default `false`
`audio`optional	`boolean`	Render `<Audio src="https://...">` native audio players. Default `false`
`bluesky`optional	`boolean`	Render `<Bluesky>` as static cards. Default `false`
`discord`optional	`boolean`	Render `<Discord>` as static invite/message cards. Default `false`
`facebook`optional	`boolean`	Render `<Facebook>` as static post cards. Default `false`
`fediverse`optional	`boolean`	Render `<Fediverse>`, `<Mastodon>`, `<Misskey>`, and `<Mixi2>` as static cards. Default `false`
`figma`optional	`boolean`	Render `<Figma>` file, design, board, and prototype cards. Default `false`
`github`optional	`boolean \| GitHubOptions`	Render `<GitHub repo="owner/name" />` repository cards. Pass an options object to configure fetching. Default `true`
`googleMaps`optional	`boolean`	Render `<GoogleMaps>` as static place cards. Default `false`
`googleSlides`optional	`boolean`	Render `<GoogleSlides>` deck cards. Default `false`
`instagram`optional	`boolean`	Render `<Instagram>` as static post cards. Default `false`
`loom`optional	`boolean`	Render `<Loom>` recording cards. Default `false`
`note`optional	`boolean`	Render `<Note>` note.com article cards. Default `false`
`openGraph`optional	`boolean \| OgpOptions`	Render `<OgCard url="https://example.com" />` Open Graph link cards. Pass an options object to configure fetching. Default `true`
`packageRegistry`optional	`boolean \| ProviderPackageEmbedOptions`	Render `<NpmPackage>`, `<CratesIo>`, `<PyPI>`, and `<DockerHub>` as static cards. Pass `{ fetch: false }` to skip metadata fetching and render link-only cards. Default `false`
`playgrounds`optional	`boolean \| ProviderPlaygroundEmbedOptions`	Render `<CodePen>`, `<JSFiddle>`, and `<Observable>` as static playground cards. Pass `{ iframe: true }` to include lazy iframe URLs where supported. Default `false`
`pm`optional	`boolean \| BuiltinPmOptions`	Expand `<pm>npm install …</pm>` blocks into vp/pnpm/bun/npm/yarn 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`
`qiita`optional	`boolean \| ProviderArticleEmbedOptions`	Render `<Qiita>` as static article cards. Pass `{ fetch: false }` to skip metadata fetching and render a link-only card. Default `false`
`reddit`optional	`boolean \| RedditEmbedOptions`	Render `<Reddit>` as a static post card. Pass `{ fetch: false }` to skip metadata fetching and render a link-only card. Default `false`
`speakerDeck`optional	`boolean`	Render `<SpeakerDeck url="https://speakerdeck.com/...">` cards. Player URLs and oEmbed-resolved share URLs render a lazy iframe plus title/author metadata. Fetch or parse failures become a link card. 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`
`threads`optional	`boolean`	Render `<Threads>` as static post cards. Default `false`
`twitch`optional	`boolean \| ProviderVideoEmbedOptions`	Render `<Twitch>` as static video, clip, and channel cards. Pass `{ iframe: true, parent: "example.com" }` to include Twitch 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`
`video`optional	`boolean`	Render `<Video src="https://...">` native video players. Default `false`
`vimeo`optional	`boolean \| ProviderVideoEmbedOptions`	Render `<Vimeo>` as static video cards. Pass `{ iframe: true }` to include lazy player iframe URLs. Default `false`
`webContainer`optional	`boolean`	Render `<WebContainer>` lazy placeholders with isolation metadata. Default `false`
`zenn`optional	`boolean \| ProviderArticleEmbedOptions`	Render `<Zenn>` as static article cards. Pass `{ fetch: false }` to skip metadata fetching and render a link-only card. 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`

interfaceCardOptionsOptions for opt-in ::: card / ::: link-card / ::: card-grid blocks.1 member

Options for opt-in ::: card / ::: link-card / ::: card-grid blocks.

Signature

export interface CardOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable the card transform when an options object is supplied. Default `true`

interfaceCascadeOptionsOpt-in _index directory frontmatter cascade. false or omitted stays off. true o…1 member

Opt-in _index directory frontmatter cascade.

false or omitted stays off. true or {} enables defaults. Set enabled: false on the object to turn the feature back off.

Signature

export interface CascadeOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable directory-level frontmatter inheritance. Default `true`

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'`

interfaceCodeGroupOptionsOptions for opt-in ::: code-group fence groups.1 member

Options for opt-in ::: code-group fence groups.

Signature

export interface CodeGroupOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable the code-group transform when an options object is supplied. Default `true`

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

interfaceConditionalBlockOptionsOptions for opt-in static conditional blocks.2 members

Options for opt-in static conditional blocks.

Signature

export interface ConditionalBlockOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable `::: if` / `::: else` blocks. Default `true when the options object is supplied.`
`values`optional	`Record<string, unknown>`	Build-time values available as `config.*` or bare identifiers. Page frontmatter wins for bare identifiers; use `config.name` to force config.

interfaceContainerOptionsOptions for opt-in ::: type custom containers.2 members

Options for opt-in ::: type custom containers.

Signature

export interface ContainerOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable the container transform when an options object is supplied. Default `true`
`types`optional	`Record<string, ContainerTypeOptions>`	Extra or overriding container types. Keys must be ASCII identifiers (`[A-Za-z0-9_-]+`). Unknown hostile names are ignored.

interfaceContainerTypeOptionsPer-type container presentation.2 members

Per-type container presentation.

Signature

export interface ContainerTypeOptions

View source

Members

Properties

Name	Type	Description
`tag`optional	`"div" \| "details"`	`"details"` renders `<details>`/`<summary>`; anything else is a `<div>`.
`title`optional	`string`	Title used when the opener does not set one.

interfaceContributorsOptionsOpt-in git contributor list.2 members

Opt-in git contributor list.

Signature

export interface ContributorsOptions

View source

Members

Properties

Name	Type	Description
`avatars`optional	`boolean`	When true and a git author email is present, render a Gravatar image from the MD5 of that email. The raw email is never written into HTML. Default is names only.
`ignore`optional	`string[]`	Author names or emails to omit. Comparison is case-insensitive and matches the full name or the full email.

interfaceDataTableOptionsOptions for opt-in csv-table / json-table fences.3 members

Options for opt-in csv-table / json-table fences.

Signature

export interface DataTableOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable the data-table transform when an options object is supplied. Default `true`
`missing`optional	`"error" \| "warn"`	What to do when an imported CSV/JSON file is missing. Default `"error"`
`rootDir`optional	`string`	Directory used to resolve `@/` and absolute import paths. When omitted, imports resolve from the Vite project root. Default `undefined`

interfaceDefinitionListOptionsOptions for opt-in PHP Markdown Extra / mdBook-style definition lists.1 member

Options for opt-in PHP Markdown Extra / mdBook-style definition lists.

Signature

export interface DefinitionListOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable the definition-list transform when an options object is supplied. Default `true`

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

interfaceDocsNavigationItemNavigation item emitted for generated docs sidebars.3 members

Navigation item emitted for generated docs sidebars.

Signature

export interface DocsNavigationItem

View source

Members

Properties

Name	Type	Description
`children`optional	`DocsNavigationItem[]`
`path`	`string`
`title`	`string`

interfaceDocsOptionsOptions for source documentation generation. The generator extracts JSDoc/TSDoc…34 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'`
`openapi`optional	`OpenApiDocsSource \| OpenApiDocsSource[] \| OpenApiDocsOptions \| false`	Local OpenAPI 3.0/3.1 JSON or YAML files to render as static REST API docs. Generated pages are written under `out/openapi/<spec>/` and use the same Markdown, stale-file cleanup, SSG, and search pipeline as source docs. Default `false`
`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…6 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'`
`provider`optional	`EditThisPageProvider`	Forge whose edit-URL shape to use. Every forge exposes a web editor at a different path — GitLab puts a `/-/` scope separator in front of it, Bitbucket edits through its source view, Gitea and Forgejo use `_edit` — so a site on the wrong shape links to a 404. Inferred from the `repoUrl` host when omitted (`gitlab.com`, `bitbucket.org`, `codeberg.org`, `gitea.com`), falling back to `'github'`. Set it explicitly for a self-hosted instance, whose hostname says nothing about the software behind it. Default inferred from `repoUrl`
`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: the value says where `srcDir` lives inside the repository, and the page path is measured from `srcDir` rather than from the directory the build runs in. Default `undefined`
`urlPattern`optional	`string`	Edit-URL template, for a forge or an instance the shapes above miss. Understands `{repoUrl}`, `{branch}`, and `{path}`; other braces are left as written. Takes precedence over `provider`. Default the pattern for the resolved `provider`

typeEditThisPageProvider = "github" | "gitlab" | "bitbucket" | "gitea"Forges with a known edit-URL shape. 'gitea' covers Forgejo, which kept the same…

Forges with a known edit-URL shape.

'gitea' covers Forgejo, which kept the same path.

Signature

export type EditThisPageProvider = "github" | "gitlab" | "bitbucket" | "gitea"

View source

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

interfaceFeedChannelOptionsOne feed's formats, source, output path, and channel metadata.11 members

One feed's formats, source, output path, and channel metadata.

Signature

export interface FeedChannelOptions

View source

Members

Properties

Name	Type	Description
`collection`optional	`string`	Named collection to publish. Defaults to `content`, or the first configured collection when `content` is absent.
`copyright`optional	`string`	Copyright / rights notice. Omitted from JSON Feed.
`description`optional	`string`	Channel description. Defaults to the SSG site description.
`favicon`optional	`string`	Favicon URL (Atom icon / JSON Feed favicon).
`formats`optional	`readonly FeedFormat[]`	Feed formats to write. Default `["rss", "atom", "json"]`
`image`optional	`string`	Channel image URL (RSS image / Atom logo / JSON Feed icon).
`items`optional	`FeedItemsSource`	Programmatic items for this channel. A channel may set either `collection` or `items`, not both.
`language`optional	`string`	Channel language (`en`, `ja`, …). Omitted when unset.
`limit`optional	`number`	Maximum number of published items, newest first. Default `20`
`path`optional	`string`	Site-relative directory for the generated files. Default `"/"`
`title`optional	`string`	Channel title. Defaults to the SSG site name.

typeFeedFormat = "rss" | "atom" | "json"Feed file formats written during SSG.

Feed file formats written during SSG.

Signature

export type FeedFormat = "rss" | "atom" | "json"

View source

interfaceFeedItemAttachmentOne JSON Feed / enclosure attachment accepted by programmatic feeds.5 members

One JSON Feed / enclosure attachment accepted by programmatic feeds.

Signature

export interface FeedItemAttachment

View source

Members

Properties

Name	Type	Description
`durationInSeconds`optional	`number`
`mimeType`optional	`string`
`sizeInBytes`optional	`number`
`title`optional	`string`
`url`	`string`

interfaceFeedItemAuthorOne feed item author accepted by programmatic feeds.2 members

One feed item author accepted by programmatic feeds.

Signature

export interface FeedItemAuthor

View source

Members

Properties

Name	Type	Description
`name`	`string`
`url`optional	`string`

interfaceFeedItemInputOne collection or programmatic item considered for a generated feed.17 members

One collection or programmatic item considered for a generated feed.

Signature

export interface FeedItemInput

View source

Members

Properties

Name	Type	Description
`attachments`optional	`readonly FeedItemAttachment[]`
`author`optional	`FeedItemAuthorInput`
`authors`optional	`readonly FeedItemAuthorInput[]`
`content`optional	`string`
`date`optional	`unknown`
`description`optional	`string`
`draft`optional	`unknown`
`frontmatter`optional	`Record<string, unknown>`
`id`optional	`string`
`image`optional	`string`
`language`optional	`string`
`lastUpdated`optional	`unknown`
`loc`optional	`string`
`path`optional	`string`
`title`optional	`string`
`unlisted`optional	`unknown`
`url`optional	`string`

typeFeedsOptions = FeedChannelOptions | readonly FeedChannelOptions[] | { [name: string]: FeedChannelOptions }Opt-in RSS / Atom / JSON Feed files written during SSG. A single object is one…

Opt-in RSS / Atom / JSON Feed files written during SSG.

A single object is one default feed. A named record or array writes multiple feeds with their own paths and channel metadata.

Signature

export type FeedsOptions = FeedChannelOptions | readonly FeedChannelOptions[] | { [name: string]: FeedChannelOptions }

View source

interfaceFileTreeIconOptionsReplaceable file-tree icons. Values are trusted site-config SVG markup or CSS c…4 members

Replaceable file-tree icons. Values are trusted site-config SVG markup or CSS class tokens, never fence content.

Signature

export interface FileTreeIconOptions

View source

Members

Properties

Name	Type	Description
`file`optional	`string`	Default file icon.
`files`optional	`Record<string, string>`	File icons keyed by extension (`ts`, `.json`).
`folder`optional	`string`	Collapsed folder icon.
`folderOpen`optional	`string`	Open folder icon.

interfaceFileTreeOptionsOptions for opt-in file-tree fences.3 members

Options for opt-in file-tree fences.

Signature

export interface FileTreeOptions

View source

Members

Properties

Name	Type	Description
`defaultOpen`optional	`boolean`	Open directory `<details>` by default. Default `true`
`enabled`optional	`boolean`	Enable the file-tree transform when an options object is supplied. Default `true`
`icons`optional	`boolean \| FileTreeIconOptions`	Render folder and file icons. Pass an object to replace the defaults. Default `true`

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.

interfaceGeneratedOpenApiDocsGenerated OpenAPI Markdown pages and sidebar metadata.2 members

Generated OpenAPI Markdown pages and sidebar metadata.

Signature

export interface GeneratedOpenApiDocs

View source

Members

Properties

Name	Type	Description
`nav`	`DocsNavigationItem[]`
`pages`	`Record<string, string>`

interfaceHeadingPermalinksOptionsOpt-in visible heading permalinks. Headings already have stable ids. Enabling t…1 member

Opt-in visible heading permalinks.

Headings already have stable ids. Enabling this appends a real <a class="header-anchor" href="#id"> using that exact id. Off by default so existing HTML stays byte-stable.

Signature

export interface HeadingPermalinksOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Emit the permalink control. Default `true`

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 }]`

interfaceIconsOptionsOpt-in self-hosted Iconify CSS for used icons. Off by default. When enabled, th…4 members

Opt-in self-hosted Iconify CSS for used icons.

Off by default. When enabled, the SSG build resolves Iconify names from installed @iconify/json or @iconify-json/* packages and emits CSS masks so the published site does not request api.iconify.design.

Signature

export interface IconsOptions

View source

Members

Properties

Name	Type	Description
`include`optional	`string[]`	Glob patterns to scan, or explicit `prefix:name` icons. Entries that look like Iconify names are used as-is (no scan).
`mode`optional	`"css-mask"`	CSS emission mode. Default `"css-mask"`
`safelist`optional	`string[]`	Iconify names that are always emitted, even when no source mentions them.
`syntax`optional	`"unocss"`	Class syntax. `"unocss"` emits `icon-[prefix--name]`. Default `"unocss"`

interfaceImageGalleryOptionsOptions for opt-in static image galleries.4 members

Options for opt-in static image galleries.

Signature

export interface ImageGalleryOptions

View source

Members

Properties

Name	Type	Description
`empty`optional	`"error" \| "warn" \| "ignore"`	Diagnostics for galleries without image items. Default `"error"`
`enabled`optional	`boolean`	Enable `::: gallery` blocks. Default `true when the options object is supplied.`
`lazy`optional	`boolean`	Add `loading="lazy"` to gallery images. Default follows `images.lazy`, or true when `images` is disabled.
`missingAlt`optional	`"error" \| "warn" \| "ignore"`	Diagnostics for image items without alt text. Default `"error"`

interfaceImageOptionsOptions for opt-in figures, captions, and lazy images.1 member

Options for opt-in figures, captions, and lazy images.

Signature

export interface ImageOptions

View source

Members

Properties

Name	Type	Description
`lazy`optional	`boolean`	Add `loading="lazy"` to transformed images. Default `true`

interfaceIncludeOptionsOptions for inlining Markdown files with . Relative path…1 member

Options for inlining Markdown files with .

Relative paths resolve from the current file. @/ and leading / resolve from rootDir. After canonicalize, paths outside rootDir are rejected.

Signature

export interface IncludeOptions

View source

Members

Properties

Name	Type	Description
`rootDir`optional	`string`	Directory used to resolve `@/` and absolute include paths. When omitted, includes resolve from the Vite project root. Default `undefined`

interfaceJsonLdOptionsPer-control flags for ssg.jsonLd. Omitted fields keep the defaults when the fea…4 members

Per-control flags for ssg.jsonLd.

Omitted fields keep the defaults when the feature itself is enabled.

Signature

export interface JsonLdOptions

View source

Members

Properties

Name	Type	Description
`breadcrumbs`optional	`boolean`	Emit `BreadcrumbList` when a visible breadcrumb trail exists. Default `true`
`graph`optional	`Record<string, unknown>[]`	Extra `@graph` nodes. Only objects are kept. The build does not invent fields inside them.
`publisher`optional	`JsonLdPublisherOptions`	Optional publisher. Only configured `name` / `url` are written. Logo and other Organization fields are never invented.
`type`optional	`JsonLdPageType`	Page `@type`. Defaults to `TechArticle`.

typeJsonLdPageType = "TechArticle" | "BlogPosting" | "WebPage"JSON-LD page node @type. Unknown values fall back to TechArticle.

JSON-LD page node @type. Unknown values fall back to TechArticle.

Signature

export type JsonLdPageType = "TechArticle" | "BlogPosting" | "WebPage"

View source

interfaceJsonLdPublisherOptionsOptional JSON-LD publisher. Empty or omitted fields are left out.2 members

Optional JSON-LD publisher. Empty or omitted fields are left out.

Signature

export interface JsonLdPublisherOptions

View source

Members

Properties

Name	Type	Description
`name`optional	`string`	Organization name.
`url`optional	`string`	Organization URL. `javascript:` and other unsafe schemes are dropped.

typeKatexFontFormats = "woff2" | "all"Which of KaTeX's font formats to emit.

Which of KaTeX's font formats to emit.

Signature

export type KatexFontFormats = "woff2" | "all"

View source

interfaceKeyboardKeysOptionsOptions for opt-in ... inline keyboard keys.3 members

Options for opt-in {kbd:...} inline keyboard keys.

Signature

export interface KeyboardKeysOptions

View source

Members

Properties

Name	Type	Description
`aliases`optional	`Record<string, string>`	Build-time aliases. Keys are matched case-insensitively and override the built-in `cmd` / `ctrl` table.
`enabled`optional	`boolean`	Enable the keyboard-key transform when an options object is supplied. Default `true`
`style`optional	`"words" \| "symbols"`	Built-in alias labels. `"words"` emits `Command`; `"symbols"` emits `⌘`. Default `"words"`

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', '日本語').

interfaceMagicLinkAliasOne configured magic-link target.3 members

One configured magic-link target.

Signature

export interface MagicLinkAlias

View source

Members

Properties

Name	Type	Description
`href`	`string`
`image`optional	`string`
`label`optional	`string`

interfaceMagicLinkImageOverrideReplace the image for an exact href or prefix.3 members

Replace the image for an exact href or prefix.

Signature

export interface MagicLinkImageOverride

View source

Members

Properties

Name	Type	Description
`href`optional	`string`
`image`	`string`
`prefix`optional	`string`

interfaceMagicLinkOptionsOptions for opt-in {link:...} rich magic links.4 members

Options for opt-in {link:...} rich magic links.

Signature

export interface MagicLinkOptions

View source

Members

Properties

Name	Type	Description
`aliases`optional	`Record<string, string \| MagicLinkAlias>`	Named aliases. A string value is treated as `{ href }`.
`enabled`optional	`boolean`	Enable the magic-link transform when an options object is supplied. Default `true`
`favicon`optional	`boolean \| { template?: string }`	Emit a favicon URL when a link has no image. `true` uses `https://{host}/favicon.ico`. Pass `{ template }` to override. The transform never fetches; the browser may load the URL later. Default `false`
`imageOverrides`optional	`MagicLinkImageOverride[]`	Replace the resolved image for matching hrefs.

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`

interfaceMarkdownSourceOptionsOpt-in Markdown source companions written beside generated HTML.2 members

Opt-in Markdown source companions written beside generated HTML.

Signature

export interface MarkdownSourceOptions

View source

Members

Properties

Name	Type	Description
`alternate`optional	`boolean`	Add `<link rel="alternate" type="text/markdown">` to generated HTML. Default `true`
`copy`optional	`boolean`	Show a page-level Copy as Markdown control in the default theme. The control copies or opens the published companion bytes, including frontmatter. Off unless set, even when companions are enabled. Default `false`

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`

typeMathErrorPolicy = "literal" | "error" | "render"What to do with a

…

run KaTeX cannot parse.

What to do with a $…$ run KaTeX cannot parse.

Signature

export type MathErrorPolicy = "literal" | "error" | "render"

View source

interfaceMathOptionsOptions for opt-in

…

…

math. Delimiter parsing lives in the native tran…3 members

Options for opt-in $…$ / $…$ math.

Delimiter parsing lives in the native transform. Typesetting uses KaTeX at build time when the optional katex peer is installed. Sites that omit math do not need that package.

Signature

export interface MathOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable the math transform when an options object is supplied. Default `true`
`fontFormats`optional	`KatexFontFormats`	Which KaTeX font formats to emit into the output directory. `.ttf` and `.woff` are three quarters of KaTeX's font bytes, and no browser that can run the rest of the site needs them — `@font-face` lists `woff2` first and stops at the first format it supports. Set `'all'` for a target that genuinely needs the older formats. Either way the fonts are emitted only when a page actually rendered math. Default `'woff2'`
`onError`optional	`MathErrorPolicy`	What to do with a $…$ run KaTeX cannot parse. The $…$ heuristics are good but not perfect, and a page about math syntax is exactly the page that trips them. This decides whether such a page ships readable prose, red error text, or no build at all. - `'literal'` puts the source back the way it was written, delimiters included, and warns. - `'error'` fails the build. - `'render'` emits KaTeX's own red error markup, which is what the feature did before this option existed. Default `'literal'`

interfaceMdxImportOne MDX import statement collected from the AST.2 members

One MDX import statement collected from the AST.

Signature

export interface MdxImport

View source

Members

Properties

Name	Type	Description
`source`	`string`	Module specifier string.
`specifiers`	`MdxImportSpecifier[]`	Bindings created by the import.

interfaceMdxImportSpecifierOne binding created by an MDX import statement.3 members

One binding created by an MDX import statement.

Signature

export interface MdxImportSpecifier

View source

Members

Properties

Name	Type	Description
`imported`	`string`	Imported name (`default`, `*`, or the named export).
`kind`	`MdxImportSpecifierKind`	Specifier kind.
`local`	`string`	Local binding name.

typeMdxImportSpecifierKind = "default" | "named" | "namespace"How a specifier was imported from an MDX import statement.

How a specifier was imported from an MDX import statement.

Signature

export type MdxImportSpecifierKind = "default" | "named" | "namespace"

View source

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.

interfaceNotByAiOptionsOptions for the opt-in <NotByAI /> authorship badge.3 members

Options for the opt-in <NotByAI /> authorship badge.

Signature

export interface NotByAiOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable the badge transform when an options object is supplied. Default `true`
`href`optional	`string`	Destination URL. Unsafe values fall back to `https://notbyai.fyi`. Default `"https://notbyai.fyi"`
`label`optional	`string`	Accessible label for the badge link. Default `"Written by human, not by AI"`

interfaceNotFoundOptionsOpt-in custom 404 page written during SSG.2 members

Opt-in custom 404 page written during SSG.

Signature

export interface NotFoundOptions

View source

Members

Properties

Name	Type	Description
`output`optional	`string`	Output file relative to `outDir`. Default `"404.html"`
`source`optional	`string`	Markdown source relative to `srcDir`. Default `"404.md"`

interfaceOgImageOptionsOG image generation options. Uses Chromium or Satori rendering with customizabl…8 members

OG image generation options. Uses Chromium or Satori 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`
`renderer`optional	`OgImageRenderer`	Rendering backend. - `"chromium"`: full browser rendering, best template compatibility - `"satori"`: fast HTML-to-SVG-to-PNG rendering, limited CSS subset Default `"chromium"`
`satori`optional	`OgImageSatoriOptions`	Options for the Satori renderer.
`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`

typeOgImageRenderer = "chromium" | "satori"OG image rendering backend.

OG image rendering backend.

Signature

export type OgImageRenderer = "chromium" | "satori"

View source

interfaceOgImageSatoriFontFont file loaded by the Satori renderer.4 members

Font file loaded by the Satori renderer.

Signature

export interface OgImageSatoriFont

View source

Members

Properties

Name	Type	Description
`name`optional	`string`	Font family name used by template CSS.
`path`	`string`	Absolute path, or a path relative to the project root.
`style`optional	`"normal" \| "italic"`	Font style. Default `"normal"`
`weight`optional	`OgImageSatoriFontWeight`	Font weight. Default `400`

typeOgImageSatoriFontWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900Font weight values supported by Satori.

Font weight values supported by Satori.

Signature

export type OgImageSatoriFontWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900

View source

interfaceOgImageSatoriOptionsSatori renderer options.2 members

Satori renderer options.

Signature

export interface OgImageSatoriOptions

View source

Members

Properties

Name	Type	Description
`fonts`optional	`OgImageSatoriFont[]`	Font files passed to Satori. Satori cannot render text without at least one font. When omitted, Ox Content tries a small set of system font paths unless `systemFontFallback` is disabled.
`systemFontFallback`optional	`boolean`	Try known OS font paths when `fonts` is empty. Default `true`

interfaceOpenApiDocsInputOne local OpenAPI file consumed by generated REST API docs.3 members

One local OpenAPI file consumed by generated REST API docs.

Signature

export interface OpenApiDocsInput

View source

Members

Properties

Name	Type	Description
`failOnUnresolvedRefs`optional	`boolean`	Fail on unresolved or remote `$ref` values. Defaults to `true`.
`name`optional	`string`	Optional display name. Defaults to `info.title` or the file name.
`path`	`string`	JSON or YAML file path, resolved from the Vite project root.

interfaceOpenApiDocsOptionsObject form for configuring generated OpenAPI docs.3 members

Object form for configuring generated OpenAPI docs.

Signature

export interface OpenApiDocsOptions

View source

Members

Properties

Name	Type	Description
`basePath`optional	`string`	Route prefix used by generated OpenAPI nav metadata. Defaults to `basePath` or `/api`.
`failOnUnresolvedRefs`optional	`boolean`	Default unresolved `$ref` policy for sources. Defaults to `true`.
`src`optional	`OpenApiDocsSource \| OpenApiDocsSource[]`	Local OpenAPI files to render.

typeOpenApiDocsSource = string | OpenApiDocsInputOpenAPI docs shorthand accepted by docs.openapi.

OpenAPI docs shorthand accepted by docs.openapi.

Signature

export type OpenApiDocsSource = string | OpenApiDocsInput

View source

interfaceOxContentOptionsOptions for the core oxContent() Vite plugin. The top-level options describe wh…76 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
`abbreviations`optional	`boolean \| AbbreviationsOptions`	Opt-in abbreviation and glossary expansion. Passing `true` or an options object expands `*[LSP]: Language Server Protocol` and config `terms` into `<abbr class="ox-abbr">`. Matching uses Unicode word boundaries. Fenced, indented, inline, and raw code, HTML comments, and existing links are skipped. There is no client JavaScript. Default `false`
`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`
`badges`optional	`boolean \| BadgeOptions`	Opt-in `{badge:variant}` inline badges. Passing `true` or an options object enables the built-in variants. Badge text is HTML-escaped. Fenced, indented, and inline code are skipped. Default `false`
`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 `'/'`
`blog`optional	`boolean \| BlogOptions`	Write a paginated blog index, tag pages, and yearly/monthly archive, and inject author / reading-time chrome on posts. Off by default. `true` uses the `blog` collection when it exists, otherwise the only configured collection, with pageSize 10. An object enables the feature and overrides only the fields you set. Also accepted as `ssg.blog`; the top-level option wins when both are set. Default `false`
`budoux`optional	`boolean \| BudouxOptions`	Opt-in build-time BudouX phrase segmentation. Inserts zero-width spaces into visible prose so Japanese text gets better line-break opportunities without shipping the BudouX parser to the browser. Install `budoux` when enabling the default parser, or pass a custom parser. Default `false`
`cards`optional	`boolean \| CardOptions`	Opt-in `::: card` / `::: link-card` / `::: card-grid` blocks. Passing `true` enables the defaults. Pass an object to keep the option shape while overriding `enabled`. Default `false`
`cascade`optional	`boolean \| CascadeOptions`	Inherit missing frontmatter keys from ancestor `_index` files. Off by default. `true` or `{}` fills keys a child does not set. `permalink` and `slug` are never inherited. Default `false`
`citations`optional	`boolean \| CitationsOptions`	Opt-in bibliography-backed citation references. References such as `[@rfc9110]` and `[@smith2024; @doe2023]` become links to generated bibliography entries loaded from local CSL JSON files. Default `false`
`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`
`codeGroups`optional	`boolean \| CodeGroupOptions`	Opt-in VitePress-style `::: code-group` fence groups. Passing `true` or `{}` enables rewriting labeled fences into the existing no-JS tab widget. Omitted or `false` leaves the source on the normal Markdown/container path. 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`
`conditionalBlocks`optional	`boolean \| ConditionalBlockOptions`	Opt-in static `::: if` / `::: else` blocks. Conditions are evaluated from `conditionalBlocks.values` and page frontmatter before Markdown is parsed. Non-selected branches are excluded from rendered HTML, TOC, and generated search payloads. The expression language supports `==`, `!=`, `in`, `and`, `or`, parentheses, string / number / boolean / null literals, and array literals. No JavaScript is executed. Default `false`
`containers`optional	`boolean \| ContainerOptions`	Opt-in `::: tip` custom containers. GitHub-style `> [!NOTE]` callouts stay available without this option. Passing `true` enables the built-in types. Pass an object to register extra types or override titles. Default `false`
`crossReferences`optional	`boolean \| CrossReferencesOptions`	Opt-in labeled cross-references for headings, figures/images, and tables. References such as `@sec-install`, `@fig-pipeline`, and `@tbl-options` become links to matching `id` attributes generated by `attrs` or native Markdown rendering. Missing labels, duplicate labels, and prefix/type mismatches fail by default and can be downgraded to warnings. Default `false`
`dataTables`optional	`boolean \| DataTableOptions`	Opt-in static tables from `csv-table` / `json-table` fences. Passing `true` or `{}` enables the transform. Inline CSV/JSON becomes a semantic `<table>` with a responsive wrapper. `src` or a single path body can import `@/data/options.csv` or `./options.json`. Paths cannot escape the content/project root with `..`. Missing imports use `missing`. Default `false`
`definitionLists`optional	`boolean \| DefinitionListOptions`	Opt-in PHP Markdown Extra / mdBook-style definition lists. Passing `true` or an options object turns `Term` / `: definition` source into semantic `<dl>` markup. Disabled when omitted. Fenced, indented, and inline code are skipped. Invalid or ambiguous forms stay ordinary paragraphs or lists. Default `false`
`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']`
`feeds`optional	`boolean \| FeedsOptions`	Write RSS, Atom, and/or JSON Feed files from a named collection. Off by default. `true` writes all three formats from the `content` collection (or the first configured collection) with a 20-item limit. An object enables the feature and overrides only the fields you set. Requires `ssg.siteUrl`. When that is missing the build continues and a warning is emitted instead of writing files. Default `false`
`fileTree`optional	`boolean \| FileTreeOptions`	Opt-in static directory trees from `file-tree` fences. Passing `true` or `{}` enables the transform. Names are escaped and never read from the filesystem. Directories with children open and close with `<details>`. Icons are on by default and can be replaced from site config. Default `false`
`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`
`graphviz`optional	`boolean \| GraphvizOptions`	Render `dot` / `graphviz` fenced blocks to static SVG with Graphviz. Pass an object to configure the renderer command and failure policy. Default `false`
`headingPermalinks`optional	`boolean \| HeadingPermalinksOptions`	Append a visible heading permalink (`<a class="header-anchor" href="#id">`). Reuses the generated heading id. Default off. Theme `headingPermalink: "hover" \| "always"` changes only CSS visibility. Default `false`
`highlight`optional	`boolean`	Enable syntax highlighting for code blocks. When true, fenced and language-tagged inline code is highlighted with the native tree-sitter engine. Token colors are `--octc-syntax-*` custom properties so theme-color packages resolve highlighting. Languages with no native grammar stay unhighlighted. Default `false`
`i18n`optional	`I18nOptions \| false`	i18n (internationalization) options. Set to false to disable i18n. Default `false`
`icons`optional	`boolean \| IconsOptions`	Generate self-hosted Iconify CSS for used and safelisted icons. Off by default. `true` or `{}` enables CSS-mask emission. Install `@iconify/json` or individual `@iconify-json/*` packages so the build can resolve collections without a network request. Default `false`
`imageGalleries`optional	`boolean \| ImageGalleryOptions`	Opt-in static `::: gallery` image groups. Each non-empty line inside the block must be a Markdown image, optionally as a list item. Image titles become item captions, and the block title or caption metadata becomes the gallery caption. Passing `true` or `{}` enables strict empty-gallery and missing-alt diagnostics. Default `false`
`images`optional	`boolean \| ImageOptions`	Opt-in figures, captions, and lazy-loaded images. Title text becomes a `<figcaption>`. Optional `{width=N height=M}` on the image is consumed by this feature and does not require `attrs`. Passing `true` or `{}` enables defaults (`lazy: true`). Default `false`
`includes`optional	`boolean \| IncludeOptions`	Inline another Markdown file with `<!-- @include: ./path.md -->`. Expansion happens before Markdown is parsed, so included headings and lists become part of the host document. Relative paths resolve from the current file. `@/` and `/` resolve from `rootDir`. Paths outside `rootDir` are rejected and reported as transform errors. Default `false`
`keyboardKeys`optional	`boolean \| KeyboardKeysOptions`	Opt-in `{kbd:...}` inline keyboard keys. Passing `true` or an options object enables `{kbd:Ctrl+K}` and `{kbd:Cmd Shift P}`. Key labels are HTML-escaped. Fenced, indented, inline, and raw code, plus HTML comments, are skipped. Aliases come from build config, not the runtime user agent. Default `false`
`magicLinks`optional	`boolean \| MagicLinkOptions`	Opt-in `{link:...}` rich magic links. Passing `true` or an options object enables GitHub-user, alias, and explicit `label\|url` forms. Attributes and text are HTML-escaped. Fenced, indented, inline, and raw code, plus already-linked text, are skipped. The transform does not make network requests unless an explicit favicon template is enabled (still URL-only; no fetch at transform time). Default `false`
`math`optional	`boolean \| MathOptions`	Enable $…$ inline and `$$…$$` block math. Currency-like `$` runs, fenced code, indented code, and inline code stay literal. TeX is HTML-escaped into accessible MathML `mtext`. Default `false`
`mdx`optional	`boolean`	Enable MDX JSX, ESM, and expressions. When omitted, MDX is enabled for `.mdx` files only. Set `true` to enable it for every configured extension or `false` to keep `.mdx` on the plain Markdown path. Default `inferred from the source extension`
`mermaid`optional	`boolean`	Enable mermaid diagram rendering. Default `false`
`notByAi`optional	`boolean \| NotByAiOptions`	Opt-in `<NotByAI />` authorship disclosure badge. Passing `true` or an options object emits the official Not By AI light/dark artwork as static HTML. This is not a status badge — see `badges` for `{badge:tip}` labels. Disabled when omitted. Fenced, indented, and inline code plus HTML comments are skipped. 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'`
`partials`optional	`boolean \| PartialsOptions`	Inline a parameterized Markdown partial with `<!-- @partial: ./_partials/install.md package="ox-content" -->`. Disabled when omitted. `{{ name }}` substitutions are HTML-escaped. Missing parameters stay literal unless `missing` is `"error"`. Existing `<!-- @include: -->` behavior is unchanged. Default `false`
`permalinks`optional	`boolean \| PermalinksOptions`	Honor frontmatter `permalink` / `slug` when resolving page URLs. Off by default. `true` or `{}` replaces the file-tree URL with `permalink`, or the last path segment with `slug`. Path escape (`../`, absolute filesystem paths, `javascript:`, protocol-relative `//`) is rejected and the file-tree URL is kept. Two pages that resolve to the same URL produce an error; the first page is kept and the later page is skipped. Default `false`
`publishState`optional	`boolean \| PublishStateOptions`	Honor frontmatter draft / unlisted / scheduled publish states. Off by default. `true` omits drafts and future-scheduled pages from production HTML, search, and sitemaps. Unlisted pages still build and remain reachable by URL. An object enables the feature and can inject `now` for a deterministic build-time clock. Default `false`
`pwa`optional	`boolean \| PwaOptions`	Write a web app manifest and an optional service worker. Off by default. `true` writes `manifest.webmanifest` and `sw.js`, and injects a tiny client script that registers the worker on themed pages. An object enables the feature and can set `offline: false` to keep the manifest without caching or that script. This adds client JavaScript when offline is on. Requires `ssg.siteUrl`. When that is missing the build continues and a warning is emitted instead of writing files. Default `false`
`redirects`optional	`boolean \| RedirectsOptions \| Record<string, string>`	Write static HTML redirect pages for frontmatter aliases and a config map. Off by default. `true` or `{}` enables empty defaults. A path map such as `{ "/old-guide": "/guide" }` enables the feature with that map. Destinations must be same-origin paths (`/` but not `//`) unless `allowExternal` is set. `javascript:`, `data:`, and protocol-relative URLs are ignored. Overlapping sources last-win after trailing slashes are folded. Default `false`
`resources`optional	`boolean \| ResourcesOptions`	Opt-in page-bundle resources and build-time image processing. Off by default. `true` or `{}` treats each page directory as a bundle: sibling images are addressable with relative URLs. Query-string resize/crop/format transforms run at build time and are cached by source mtime plus transform params. Paths that leave the page directory or `srcDir` are rejected. Missing sources fail the build when `missing` is `"error"` (the default when enabled). `dedupe` is off unless set; it does not turn on with `true` / `{}`. This is separate from `images`, which only adds figures, captions, and lazy-loading. Default `false`
`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 }`
`semanticFootnotes`optional	`boolean`	Render footnotes as a semantic ordered section with numeric markers. Source identifiers are used only for lookup and slugs. Visible markers are 1, 2, … in document order, and definitions emit as `<section class="footnotes"><ol><li>…`. Off by default so current alpha HTML stays stable. Default `false`
`siteMaps`optional	`boolean \| SiteMapsOptions`	Write crawl manifests next to generated HTML. Off by default. `true` writes `sitemap.xml`, `robots.txt`, and `llms.txt`. An object enables the feature and overrides only the fields you set. Requires `ssg.siteUrl`. When that is missing the build continues and a warning is emitted instead of writing files. Default `false`
`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 }`
`steps`optional	`boolean \| StepsOptions`	Restyle a `::: steps` wrapper around an ordered list. Disabled when omitted or `false`. `true` and `{}` enable the default step-list markup. Ordinary ordered lists outside `::: steps` are unchanged. Default `false`
`strikethrough`optional	`boolean`	Enable strikethrough. Default `true`
`tables`optional	`boolean`	Enable tables. Default `true`
`taskLists`optional	`boolean`	Enable task lists. Default `true`
`taxonomies`optional	`boolean \| TaxonomiesOptions`	Write tag/category term pages and inject related-page lists. Off by default. `true` reads frontmatter `tags` and `categories` and writes list pages, per-term pages, and up to 5 related links on pages that share a term. An object enables the feature and overrides only the fields you set. Term slugs are `[a-z0-9-]` and every label is HTML-escaped. Default `false`
`timelines`optional	`boolean \| TimelineOptions`	Opt-in static `::: timeline` milestone lists. Timeline blocks render dated or undated milestones from Markdown-only `::: timeline` blocks. Items can carry `status`, `label`, and `href` metadata while nested Markdown stays searchable and static. Default `false`
`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 `[]`
`typedHover`optional	`boolean \| TypedHoverOptions`	Attach build-time TypeScript hover overlays to opted-in fences. Off by default. `true` or `{}` enables the feature. Only `ts` / `tsx` fences tagged `twoslash` receive payloads. Types are generated during the Markdown transform; no TypeScript compiler is shipped to the browser. Default `false`
`versions`optional	`boolean \| VersionsOptions`	Prefix live docs, emit frozen snapshot trees, and render a header version dropdown. Off by default. `true` enables a single current entry. An object enables the feature and lists additional versions. Historical snapshot directories are read, never rewritten. Default `false`
`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`
`xrefs`optional	`boolean \| CrossReferencesOptions`	Alias for `crossReferences`. 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.

interfacePartialsOptionsOptions for parameterized Markdown partials with .…4 members

Options for parameterized Markdown partials with .

Bare names resolve under root (_partials by default). Relative ./ and ../ paths resolve from the current file. @/ and leading / resolve from rootDir. After canonicalize, paths outside rootDir are rejected.

Signature

export interface PartialsOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable the transform when an options object is supplied. Default `true`
`missing`optional	`"literal" \| "error"`	Missing `{{ name }}` substitutions stay literal, or report a diagnostic. Default `"literal"`
`root`optional	`string`	Directory used for bare names such as `install.md`. Default `"_partials"`
`rootDir`optional	`string`	Directory used to resolve `@/` and absolute partial paths. Default `undefined`

interfacePermalinksOptionsOpt-in frontmatter permalink / slug routing. false or omitted stays off. true o…1 member

Opt-in frontmatter permalink / slug routing.

false or omitted stays off. true or {} enables defaults. Set enabled: false on the object to turn the feature back off.

Signature

export interface PermalinksOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable permalink / slug routing. Default `true`

interfacePublishStateOptionsOpt-in draft / unlisted / scheduled page filtering.3 members

Opt-in draft / unlisted / scheduled page filtering.

Signature

export interface PublishStateOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	When `false`, frontmatter publish fields are ignored. Default `true when the option is an object`
`includeDrafts`optional	`boolean`	Keep draft and not-yet-scheduled pages in output. The dev server sets this. Default `false`
`now`optional	`string`	Injected ISO-8601 clock compared against `scheduled`, `date`, and `expiry`. Invalid values fall back to the system clock.

interfacePwaOptionsOpt-in web app manifest and service worker written during SSG. Enabling offline…6 members

Opt-in web app manifest and service worker written during SSG.

Enabling offline (the default when the feature is on) injects a tiny client script that registers sw.js. Set offline: false to keep the manifest without that script.

Signature

export interface PwaOptions

View source

Members

Properties

Name	Type	Description
`backgroundColor`optional	`string`	Manifest background color. Hex or a CSS color name. Default `"#ffffff"`
`name`optional	`string`	Manifest `name`. Falls back to `ssg.siteName` when omitted.
`offline`optional	`boolean`	Write `sw.js` and register it from themed pages. Default `true`
`shortName`optional	`string`	Manifest `short_name`. Falls back to `name` when omitted.
`startUrl`optional	`string`	Manifest `start_url`. Same-origin site paths only (`/`, `/docs/`). Defaults to the Vite `base`.
`themeColor`optional	`string`	Manifest / meta theme color. Hex (`#rgb` / `#rrggbb`) or a CSS color name. Default `"#000000"`

typeRedirectProvider = "netlify" | "cloudflare"Host that consumes the generated redirects file. Both values write the same r…

Host that consumes the generated _redirects file.

Both values write the same _redirects body today. The distinct names leave room for provider-specific limits and diagnostics later.

Signature

export type RedirectProvider = "netlify" | "cloudflare"

View source

interfaceRedirectsOptionsOpt-in static redirects, aliases, and path rewrites. A path map such as { "/old…6 members

Opt-in static redirects, aliases, and path rewrites.

A path map such as { "/old-guide": "/guide" } is also accepted in place of this object and enables the feature with that map.

Signature

export interface RedirectsOptions

View source

Members

Properties

Name	Type	Description
`allowExternal`optional	`boolean`	Allow `http://` and `https://` destinations. `javascript:`, `data:`, and protocol-relative `//` targets stay rejected. Default `false`
`headers`optional	`boolean`	Write a `_headers` Location map next to the HTML pages. Default `false`
`html`optional	`boolean`	Write static HTML fallback pages for ordinary redirect sources. Set `false` when the selected host should consume `_redirects` directly. Wildcard sources never write HTML pages because they are host-rule syntax. Default `true`
`json`optional	`boolean`	Write a machine-readable `redirects.json` map. Default `false`
`map`optional	`Record<string, string>`	Old path to new path. Destinations must be same-origin (`/` but not `//`) unless `allowExternal` is set. Default `{}`
`provider`optional	`RedirectProvider`	Host that should receive a `_redirects` file. Omit the field to detect `CF_PAGES=1`, `WORKERS_CI=1`, or `NETLIFY=true`. Local builds and GitHub Actions should set this explicitly. HTML redirect pages are independent of this selector.

typeResolvedA11y = false | { skipLinkLabel: string }Resolved skip-link / print styles. false means no extra markup or CSS.

Resolved skip-link / print styles. false means no extra markup or CSS.

Signature

export type ResolvedA11y = false | { skipLinkLabel: string }

View source

interfaceResolvedAbbreviationsOptionsResolved abbreviation / glossary transform options.3 members

Resolved abbreviation / glossary transform options.

Signature

export interface ResolvedAbbreviationsOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`firstUseOnly`	`boolean`
`terms`	`Record<string, string>`

interfaceResolvedAttrsOptionsResolved attrs transform options.1 member

Resolved attrs transform options.

Signature

export interface ResolvedAttrsOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`

interfaceResolvedBadgeOptionsResolved inline-badge transform options.1 member

Resolved inline-badge transform options.

Signature

export interface ResolvedBadgeOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`

interfaceResolvedBlogFeedSourceResolved external blog feed source.4 members

Resolved external blog feed source.

Signature

export interface ResolvedBlogFeedSource

View source

Members

Properties

Name	Type	Description
`author`optional	`string`
`language`optional	`string`
`onError`	`BlogFeedFailurePolicy`
`url`	`string`

interfaceResolvedBlogOptionsResolved blog options.5 members

Resolved blog options.

Signature

export interface ResolvedBlogOptions

View source

Members

Properties

Name	Type	Description
`authors`	`Record<string, BlogAuthor>`
`collection`optional	`string`
`enabled`	`boolean`
`feeds`	`ResolvedBlogFeedSource[]`
`pageSize`	`number`

interfaceResolvedBuiltinEmbedOptionsResolved built-in embed configuration.30 members

Resolved built-in embed configuration.

Signature

export interface ResolvedBuiltinEmbedOptions

View source

Members

Properties

Name	Type	Description
`appleMusic`	`boolean`
`asciinema`optional	`boolean`
`audio`optional	`boolean`
`bluesky`	`boolean`
`discord`optional	`boolean`
`facebook`optional	`boolean`
`fediverse`optional	`boolean`
`figma`optional	`boolean`
`github`	`GitHubOptions \| false`
`googleMaps`optional	`boolean`
`googleSlides`optional	`boolean`
`instagram`optional	`boolean`
`loom`optional	`boolean`
`note`optional	`boolean`
`openGraph`	`OgpOptions \| false`
`packageRegistry`optional	`ProviderPackageEmbedOptions \| false`
`playgrounds`optional	`ProviderPlaygroundEmbedOptions \| false`
`pm`	`BuiltinPmOptions \| false`
`qiita`optional	`ProviderArticleEmbedOptions \| false`
`reddit`optional	`RedditEmbedOptions \| false`
`speakerDeck`	`boolean`
`spotify`	`boolean`
`stackBlitz`	`boolean`
`threads`optional	`boolean`
`twitch`optional	`ProviderVideoEmbedOptions \| false`
`twitter`	`TwitterEmbedOptions \| false`
`video`optional	`boolean`
`vimeo`optional	`ProviderVideoEmbedOptions \| false`
`webContainer`	`boolean`
`zenn`optional	`ProviderArticleEmbedOptions \| false`

interfaceResolvedCardOptionsResolved card transform options.1 member

Resolved card transform options.

Signature

export interface ResolvedCardOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`

interfaceResolvedCascadeOptionsResolved cascade options.1 member

Resolved cascade options.

Signature

export interface ResolvedCascadeOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`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`

interfaceResolvedCodeGroupOptionsResolved code-group transform options.1 member

Resolved code-group transform options.

Signature

export interface ResolvedCodeGroupOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`

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`

interfaceResolvedConditionalBlockOptionsResolved conditional-block transform options.2 members

Resolved conditional-block transform options.

Signature

export interface ResolvedConditionalBlockOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`values`	`Record<string, unknown>`

interfaceResolvedContainerOptionsResolved custom-container transform options.2 members

Resolved custom-container transform options.

Signature

export interface ResolvedContainerOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`types`	`Record<string, ContainerTypeOptions>`

typeResolvedContributors = false | { ignore: string[]; avatars: boolean }Resolved git contributor list. false means the feature is off.

Resolved git contributor list. false means the feature is off.

Signature

export type ResolvedContributors = false | { ignore: string[]; avatars: boolean }

View source

interfaceResolvedDataTableOptionsResolved data-table transform options.3 members

Resolved data-table transform options.

Signature

export interface ResolvedDataTableOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`missing`	`"error" \| "warn"`
`rootDir`optional	`string`

interfaceResolvedDefinitionListOptionsResolved definition-list transform options.1 member

Resolved definition-list transform options.

Signature

export interface ResolvedDefinitionListOptions

View source

Members

Properties

Name	Type	Description
`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.34 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"`
`openapi`	`ResolvedOpenApiDocsOptions \| false`
`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.7 members

Resolved edit-link transform options.

Signature

export interface ResolvedEditThisPageOptions

View source

Members

Properties

Name	Type	Description
`branch`	`string`
`enabled`	`boolean`
`label`	`string`
`provider`optional	`EditThisPageProvider`
`repoUrl`optional	`string`
`rootDir`optional	`string`
`urlPattern`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`

interfaceResolvedFeedChannelOne resolved feed channel.12 members

One resolved feed channel.

Signature

export interface ResolvedFeedChannel

View source

Members

Properties

Name	Type	Description
`collection`optional	`string`
`copyright`optional	`string`
`description`optional	`string`
`favicon`optional	`string`
`formats`	`readonly FeedFormat[]`
`image`optional	`string`
`items`optional	`FeedItemsSource`
`language`optional	`string`
`limit`	`number`
`name`optional	`string`
`path`	`string`
`title`optional	`string`

interfaceResolvedFeedsOptions extends ResolvedFeedChannelResolved feed options. Legacy true / single-object configs keep one channel on…2 members

Resolved feed options.

Legacy true / single-object configs keep one channel on the top-level fields. A named record or array also sets feeds to every channel.

Signature

export interface ResolvedFeedsOptions extends ResolvedFeedChannel

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`feeds`optional	`ResolvedFeedChannel[]`

interfaceResolvedFileTreeOptionsResolved file-tree transform options.7 members

Resolved file-tree transform options.

Signature

export interface ResolvedFileTreeOptions

View source

Members

Properties

Name	Type	Description
`defaultOpen`	`boolean`
`enabled`	`boolean`
`iconFile`optional	`string`
`iconFiles`optional	`Record<string, string>`
`iconFolder`optional	`string`
`iconFolderOpen`optional	`string`
`icons`	`boolean`

interfaceResolvedHeadingPermalinksOptionsResolved heading permalink options.1 member

Resolved heading permalink options.

Signature

export interface ResolvedHeadingPermalinksOptions

View source

Members

Properties

Name	Type	Description
`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[]`

interfaceResolvedIconsOptionsResolved icon asset options.5 members

Resolved icon asset options.

Signature

export interface ResolvedIconsOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`include`	`string[]`
`mode`	`"css-mask"`
`safelist`	`string[]`
`syntax`	`"unocss"`

interfaceResolvedImageGalleryOptionsResolved image gallery transform options.4 members

Resolved image gallery transform options.

Signature

export interface ResolvedImageGalleryOptions

View source

Members

Properties

Name	Type	Description
`empty`	`"error" \| "warn" \| "ignore"`
`enabled`	`boolean`
`lazy`optional	`boolean`
`missingAlt`	`"error" \| "warn" \| "ignore"`

interfaceResolvedImageOptionsResolved image transform options.2 members

Resolved image transform options.

Signature

export interface ResolvedImageOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`lazy`	`boolean`

interfaceResolvedIncludeOptionsResolved Markdown-include transform options.2 members

Resolved Markdown-include transform options.

Signature

export interface ResolvedIncludeOptions

View source

Members

Properties

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

type

ResolvedJsonLd = false | { breadcrumbs: boolean; publisher?: { name?: string; url?: string }; type?: JsonLdPageType; graph?: Record<string, unknown>[] }

Resolved JSON-LD options. false means no <script type="application/ld+json">.

Resolved JSON-LD options. false means no <script type="application/ld+json">.

Signature

export type ResolvedJsonLd = false | { breadcrumbs: boolean; publisher?: { name?: string; url?: string }; type?: JsonLdPageType; graph?: Record<string, unknown>[] }

View source

interfaceResolvedKeyboardKeysOptionsResolved inline keyboard-key transform options.3 members

Resolved inline keyboard-key transform options.

Signature

export interface ResolvedKeyboardKeysOptions

View source

Members

Properties

Name	Type	Description
`aliases`	`Record<string, string>`
`enabled`	`boolean`
`style`	`"words" \| "symbols"`

interfaceResolvedMagicLinkOptionsResolved magic-link transform options.5 members

Resolved magic-link transform options.

Signature

export interface ResolvedMagicLinkOptions

View source

Members

Properties

Name	Type	Description
`aliases`	`Record<string, MagicLinkAlias>`
`enabled`	`boolean`
`favicon`	`boolean`
`faviconTemplate`optional	`string`
`imageOverrides`	`MagicLinkImageOverride[]`

interfaceResolvedMarkdownSourceOptionsResolved Markdown source-companion options.3 members

Resolved Markdown source-companion options.

Signature

export interface ResolvedMarkdownSourceOptions

View source

Members

Properties

Name	Type	Description
`alternate`	`boolean`
`copy`	`boolean`
`enabled`	`boolean`

interfaceResolvedMathOptionsResolved math transform options.3 members

Resolved math transform options.

Signature

export interface ResolvedMathOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`fontFormats`	`KatexFontFormats`
`onError`	`MathErrorPolicy`

interfaceResolvedNotByAiOptionsResolved NotByAI authorship-badge options.3 members

Resolved NotByAI authorship-badge options.

Signature

export interface ResolvedNotByAiOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`href`	`string`
`label`	`string`

interfaceResolvedNotFoundOptionsResolved custom 404 options.3 members

Resolved custom 404 options.

Signature

export interface ResolvedNotFoundOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`output`	`string`
`source`	`string`

interfaceResolvedOgImageOptionsResolved OG image options with all defaults applied.8 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`
`renderer`	`OgImageRenderer`
`satori`	`{ fonts: OgImageSatoriFont[]; systemFontFallback: boolean }`
`template`optional	`string`
`vuePlugin`	`"vitejs" \| "vizejs"`
`width`	`number`

interfaceResolvedOpenApiDocsInputResolved local OpenAPI file input.3 members

Resolved local OpenAPI file input.

Signature

export interface ResolvedOpenApiDocsInput

View source

Members

Properties

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

interfaceResolvedOpenApiDocsOptionsResolved generated OpenAPI docs options.2 members

Resolved generated OpenAPI docs options.

Signature

export interface ResolvedOpenApiDocsOptions

View source

Members

Properties

Name	Type	Description
`basePath`optional	`string`
`src`	`ResolvedOpenApiDocsInput[]`

interfaceResolvedOptionsResolved options with all defaults applied.75 members

Resolved options with all defaults applied.

Signature

export interface ResolvedOptions

View source

Members

Properties

Name	Type	Description
`abbreviations`optional	`ResolvedAbbreviationsOptions`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`attrs`	`ResolvedAttrsOptions`
`autolinks`	`boolean`
`badges`	`ResolvedBadgeOptions`
`base`	`string`
`blog`optional	`ResolvedBlogOptions`
`budoux`optional	`ResolvedBudouxOptions`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`cards`	`ResolvedCardOptions`
`cascade`optional	`ResolvedCascadeOptions`
`citations`	`ResolvedCitationsOptions`
`cjkEmphasis`	`boolean`
`codeAnnotations`	`ResolvedCodeAnnotationsOptions`
`codeBlockLint`	`ResolvedCodeBlockLintOptions`
`codeBlockTypecheck`	`ResolvedCodeBlockTypecheckOptions`
`codeGroups`optional	`ResolvedCodeGroupOptions`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`codeImports`	`ResolvedCodeImportOptions`
`collections`	`ResolvedCollectionsOptions`
`conditionalBlocks`optional	`ResolvedConditionalBlockOptions`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`containers`	`ResolvedContainerOptions`
`crossReferences`	`ResolvedCrossReferencesOptions`
`dataTables`	`ResolvedDataTableOptions`
`definitionLists`optional	`ResolvedDefinitionListOptions`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`docs`	`ResolvedDocsOptions \| false`
`docsTests`	`ResolvedDocsTestOptions`
`editThisPage`	`ResolvedEditThisPageOptions`
`embeds`	`ResolvedBuiltinEmbedOptions`
`emojiShortcodes`	`ResolvedEmojiShortcodeOptions`
`extensions`	`string[]`
`feeds`optional	`ResolvedFeedsOptions`
`fileTree`	`ResolvedFileTreeOptions`
`footnotes`	`boolean`
`frontmatter`	`boolean`
`gfm`	`boolean`
`graphviz`	`ResolvedGraphvizOptions \| false`
`headingPermalinks`optional	`ResolvedHeadingPermalinksOptions`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`highlight`	`boolean`
`i18n`	`ResolvedI18nOptions \| false`
`icons`optional	`ResolvedIconsOptions`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`imageGalleries`optional	`ResolvedImageGalleryOptions`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`images`	`ResolvedImageOptions`
`includes`	`ResolvedIncludeOptions`
`keyboardKeys`optional	`ResolvedKeyboardKeysOptions`
`magicLinks`optional	`ResolvedMagicLinkOptions`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`math`	`ResolvedMathOptions`
`mdx`optional	`boolean`
`mermaid`	`boolean`
`notByAi`optional	`ResolvedNotByAiOptions`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`ogImage`	`boolean`
`ogImageOptions`	`ResolvedOgImageOptions`
`ogViewer`	`boolean`
`outDir`	`string`
`partials`optional	`ResolvedPartialsOptions`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`permalinks`optional	`ResolvedPermalinksOptions`
`publishState`optional	`ResolvedPublishStateOptions`
`pwa`optional	`ResolvedPwaOptions`
`redirects`optional	`ResolvedRedirectsOptions`
`resources`optional	`ResolvedResourcesOptions`
`sanitize`	`ResolvedSanitizeOptions`
`search`	`ResolvedSearchOptions`
`semanticFootnotes`optional	`boolean`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`siteMaps`optional	`ResolvedSiteMapsOptions`
`srcDir`	`string`
`ssg`	`ResolvedSsgOptions`
`steps`	`ResolvedStepsOptions`
`strikethrough`	`boolean`
`tables`	`boolean`
`taskLists`	`boolean`
`taxonomies`optional	`ResolvedTaxonomiesOptions`
`timelines`optional	`ResolvedTimelineOptions`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`toc`	`boolean`
`tocMaxDepth`	`number`
`transformers`	`MarkdownTransformer[]`
`typedHover`optional	`ResolvedTypedHoverOptions`	Present after `resolveOptions`. Omitted in hand-built fixtures means off.
`versions`optional	`ResolvedVersionsOptions`
`wikiLinks`	`ResolvedWikiLinkOptions`

interfaceResolvedPartialsOptionsResolved parameterized-partial transform options.4 members

Resolved parameterized-partial transform options.

Signature

export interface ResolvedPartialsOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`missing`	`"literal" \| "error"`
`root`	`string`
`rootDir`optional	`string`

interfaceResolvedPermalinksOptionsResolved permalink options.1 member

Resolved permalink options.

Signature

export interface ResolvedPermalinksOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`

interfaceResolvedPublishStateOptionsResolved publish-state options.3 members

Resolved publish-state options.

Signature

export interface ResolvedPublishStateOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`includeDrafts`	`boolean`
`now`optional	`string`

interfaceResolvedPwaOptionsResolved PWA options.7 members

Resolved PWA options.

Signature

export interface ResolvedPwaOptions

View source

Members

Properties

Name	Type	Description
`backgroundColor`optional	`string`
`enabled`	`boolean`
`name`optional	`string`
`offline`	`boolean`
`shortName`optional	`string`
`startUrl`optional	`string`
`themeColor`optional	`string`

interfaceResolvedRedirectsOptionsResolved redirect options.7 members

Resolved redirect options.

Signature

export interface ResolvedRedirectsOptions

View source

Members

Properties

Name	Type	Description
`allowExternal`	`boolean`
`enabled`	`boolean`
`headers`	`boolean`
`html`	`boolean`
`json`	`boolean`
`map`	`Record<string, string>`
`provider`optional	`RedirectProvider`

interfaceResolvedResourcesOptionsResolved page-resource options.5 members

Resolved page-resource options.

Signature

export interface ResolvedResourcesOptions

View source

Members

Properties

Name	Type	Description
`dedupe`	`boolean`
`enabled`	`boolean`
`formats`	`string[]`
`missing`	`"error" \| "warn"`
`widths`	`number[]`

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.12 members

Resolved search options.

Signature

export interface ResolvedSearchOptions

View source

Members

Properties

Name	Type	Description
`appId`optional	`string`
`enabled`	`boolean`
`endpoint`optional	`string`
`fuzzy`	`boolean`
`hotkey`	`string`
`indexName`optional	`string`
`limit`	`number`
`placeholder`	`string`
`prefix`	`boolean`
`provider`optional	`"local" \| "hosted"`
`publicKey`optional	`string`
`searchKey`optional	`string`

interfaceResolvedSectionIndexOptionsResolved generated section index options.2 members

Resolved generated section index options.

Signature

export interface ResolvedSectionIndexOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`style`	`SectionIndexStyle`

interfaceResolvedSiteMapsOptionsResolved crawl-manifest options.3 members

Resolved crawl-manifest options.

Signature

export interface ResolvedSiteMapsOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`llms`	`boolean`
`robots`	`boolean`

interfaceResolvedSsgOptionsResolved SSG options.32 members

Resolved SSG options.

Signature

export interface ResolvedSsgOptions

View source

Members

Properties

Name	Type	Description
`a11y`	`ResolvedA11y`
`bare`	`boolean`
`blog`optional	`ResolvedBlogOptions`	Present after `resolveSsgOptions`. Omitted in hand-built fixtures means off.
`bodyEnd`optional	`string`
`bodyStart`optional	`string`
`breadcrumbs`	`boolean`
`clean`	`boolean`
`contributors`optional	`ResolvedContributors`	Present after `resolveSsgOptions`. Omitted in hand-built fixtures means off.
`enabled`	`boolean`
`extension`	`string`
`generateOgImage`	`boolean`
`head`optional	`string`
`headValidation`optional	`false \| "warn" \| "strict"`	Present after `resolveSsgOptions`. Omitted / `false` means off.
`jsonLd`	`ResolvedJsonLd`
`lang`optional	`string`
`lastUpdated`	`boolean`
`localeSwitcher`	`boolean`
`markdownSource`optional	`ResolvedMarkdownSourceOptions`	Present after `resolveSsgOptions`. Omitted in hand-built fixtures means off.
`navigation`optional	`SsgNavigationGroup[]`
`notFound`optional	`ResolvedNotFoundOptions`	Present after `resolveSsgOptions`. Omitted in hand-built fixtures means off.
`ogImage`optional	`string`
`pageChrome`	`boolean`
`pagination`	`boolean`
`readerChrome`	`ResolvedReaderChrome`
`render`optional	`ThemeComponent`
`routePrefix`optional	`string`	Present after `resolveSsgOptions`. Omitted / empty means off.
`sectionIndex`optional	`ResolvedSectionIndexOptions`
`siteName`optional	`string`
`siteUrl`optional	`string`
`team`optional	`ResolvedTeamOptions`	Present after `resolveSsgOptions`. Omitted in hand-built fixtures means off.
`theme`optional	`ResolvedThemeConfig`
`transformConcurrency`optional	`number`

interfaceResolvedStepsOptionsResolved step-list transform options.1 member

Resolved step-list transform options.

Signature

export interface ResolvedStepsOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`

interfaceResolvedTaxonomiesOptionsResolved taxonomy options.3 members

Resolved taxonomy options.

Signature

export interface ResolvedTaxonomiesOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`relatedLimit`	`number`
`taxonomies`	`string[]`

interfaceResolvedTeamOptionsResolved team page options.2 members

Resolved team page options.

Signature

export interface ResolvedTeamOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`members`	`TeamMember[]`

interfaceResolvedTimelineOptionsResolved timeline transform options.5 members

Resolved timeline transform options.

Signature

export interface ResolvedTimelineOptions

View source

Members

Properties

Name	Type	Description
`empty`	`"error" \| "warn" \| "ignore"`
`enabled`	`boolean`
`invalidDate`	`"error" \| "warn" \| "ignore"`
`ordered`	`boolean`
`unknownMeta`	`"error" \| "warn" \| "ignore"`

interfaceResolvedTypedHoverOptionsResolved typed-hover options.3 members

Resolved typed-hover options.

Signature

export interface ResolvedTypedHoverOptions

View source

Members

Properties

Name	Type	Description
`enabled`	`boolean`
`languages`	`string[]`
`tsgoCommand`optional	`string`

interfaceResolvedVersionEntryOne resolved version after prefix and banner sanitization.5 members

One resolved version after prefix and banner sanitization.

Signature

export interface ResolvedVersionEntry

View source

Members

Properties

Name	Type	Description
`banner`	`VersionBannerKind \| false`
`dir`optional	`string`
`id`	`string`
`label`	`string`
`prefix`	`string`

interfaceResolvedVersionsOptionsResolved documentation versioning.5 members

Resolved documentation versioning.

Signature

export interface ResolvedVersionsOptions

View source

Members

Properties

Name	Type	Description
`badge`	`boolean`
`current`	`string`
`enabled`	`boolean`
`entries`	`ResolvedVersionEntry[]`
`switcher`	`boolean`

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`

interfaceResourcesOptionsOptions for opt-in page-bundle resources and image processing.4 members

Options for opt-in page-bundle resources and image processing.

Signature

export interface ResourcesOptions

View source

Members

Properties

Name	Type	Description
`dedupe`optional	`boolean`	Emit identical bytes once as `/assets/content/<sha256>.<ext>` and rewrite `src`, `poster`, and relevant `href` to that URL. Off unless this is `true`. `resources: true` and `{}` leave it off. Default `false`
`formats`optional	`string[]`	Allowed output formats for `?format=`. `jpg` is treated as `jpeg`. Pixel transforms encode `png` and `jpeg`. `webp` is copied when the source is already webp and no pixel transform is requested. Default `["png", "jpeg", "webp"]`
`missing`optional	`"error" \| "warn"`	What to do when a relative resource is missing. Default `"error"`
`widths`optional	`number[]`	Allowed `?width=` / `?w=` values. An empty list allows any positive width. Default `[]`

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…12 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
`appId`optional	`string`	Hosted search application id. Required when `provider` is `"hosted"`. Also read from `OX_CONTENT_SEARCH_APP_ID` when omitted here.
`enabled`optional	`boolean`	Enable search functionality. Set this to `false` when config merging requires an object shape but search should be disabled. Default `true`
`endpoint`optional	`string`	HTTP endpoint that receives hosted search queries. Also read from `OX_CONTENT_SEARCH_ENDPOINT`. Defaults to `/search` when hosted credentials are present.
`fuzzy`optional	`boolean`	Enable fuzzy typo-tolerant matching. Fuzzy matching is off by default so large static indexes keep the fastest exact/prefix path. When enabled, local BM25 also considers near matches for tokens with at least three characters. Default `false`
`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 `'/'`
`indexName`optional	`string`	Hosted search index name. Required when `provider` is `"hosted"`. Also read from `OX_CONTENT_SEARCH_INDEX_NAME` when omitted here.
`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`
`provider`optional	`"local" \| "hosted"`	Search backend used by `virtual:ox-content/search`. `"local"` (the default) keeps the static BM25 `search-index.json` client. `"hosted"` sends queries to a remote index with a public search-only key. Hosted search is used only when this is set to `"hosted"`. Default `'local'`
`publicKey`optional	`string`	Alias for `searchKey`. Also read from `OX_CONTENT_SEARCH_PUBLIC_KEY` when omitted here.
`searchKey`optional	`string`	Public search-only key for the hosted provider. Write and admin keys are rejected. Also read from `OX_CONTENT_SEARCH_KEY` when omitted here.

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.

interfaceSectionIndexOptionsOpt-in generated section index pages.1 member

Opt-in generated section index pages.

Signature

export interface SectionIndexOptions

View source

Members

Properties

Name	Type	Description
`style`optional	`SectionIndexStyle`	How children are rendered. `cards` is the default when the feature is on. Default `"cards"`

typeSectionIndexStyle = "list" | "cards"Listing style for a generated section index.

Listing style for a generated section index.

Signature

export type SectionIndexStyle = "list" | "cards"

View source

interfaceSiteMapsOptionsOpt-in crawl manifests written during SSG.2 members

Opt-in crawl manifests written during SSG.

Signature

export interface SiteMapsOptions

View source

Members

Properties

Name	Type	Description
`llms`optional	`boolean`	Write `llms.txt` with the site title, description, and page URLs. Default `true`
`robots`optional	`boolean`	Write `robots.txt` with a Sitemap line. Default `true`

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…32 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
`a11y`optional	`boolean \| A11yOptions`	Opt-in skip link and print styles. Disabled when omitted or `false`. `true` enables the default skip link and print CSS. An object enables the feature and can override the label. Default `false`
`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`
`blog`optional	`boolean \| BlogOptions`	Opt-in blog index, authors, tags, reading time, and archive. Off by default. `true` enables defaults. An object enables the feature and overrides only the fields you set. Top-level `blog` wins when both are set. Default `false`
`bodyEnd`optional	`string`	Raw markup inserted directly before `</body>`. Bare mode only. Use it for a site footer, or scripts you inject yourself. Default `undefined`
`bodyStart`optional	`string`	Raw markup inserted directly after `<body>`. Bare mode only. Use it for a site header that wraps the rendered page. Default `undefined`
`breadcrumbs`optional	`boolean \| Record<string, unknown>`	Show a breadcrumb trail from the site root through sidebar ancestors. Disabled when omitted or `false`. `true` enables the default trail. An object also enables the feature. Frontmatter `breadcrumbs: false` hides the trail on that page. 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`
`contributors`optional	`boolean \| ContributorsOptions`	List unique git authors for each page. Off by default. `true` enables names only. An object enables the feature and can set `ignore` and `avatars`. Missing `.git` (for example a published tarball) yields an empty list and does not fail the build. 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. Under `bare`, the images are still written but nothing references them, because bare output has no `<head>` to put the `<meta>` tags in — inject them from your own shell. Default `false`
`head`optional	`string`	Raw markup appended to `<head>`. Bare mode only — themed pages own their head. Use it for the stylesheet your own build emits, or any tag the plugin does not generate. Default `undefined`
`headValidation`optional	`false \| "warn" \| "strict"`	Validate custom page-head descriptors during SSG. `false` / omitted drops invalid values silently. `warn` logs them. `strict` fails the build on unsafe URLs or invalid hreflang. Default `false`
`jsonLd`optional	`boolean \| JsonLdOptions`	Emit JSON-LD structured data (`TechArticle`, `WebSite`, and optional `BreadcrumbList`) in the page `<head>`. Disabled when omitted or `false`. `true` enables the defaults. An object enables the feature and can hide BreadcrumbList or supply a publisher. Publisher fields the site does not set are not invented. Default `false`
`lang`optional	`string`	`lang` attribute for the generated `<html>` element. Bare mode uses this verbatim; themed pages derive it from `i18n` instead. Default `"en"`
`lastUpdated`optional	`boolean`	Add each page's last git commit timestamp to the default theme. Default `false`
`localeSwitcher`optional	`boolean \| Record<string, unknown>`	Show a header locale switcher in the default theme. Disabled when omitted or `false`, even if `i18n.locales` is set. `true` or an object enables the control when available locales are non-empty. Links use the sibling page when it exists, otherwise the locale root (`/{locale}/` or a configured root). Default `false`
`markdownSource`optional	`boolean \| MarkdownSourceOptions`	Publish the original Markdown beside each generated HTML page. Off by default. `true` writes a `.md` companion using the published URL (permalink, locale, base, and output directory) and adds `<link rel="alternate" type="text/markdown">`. An object enables the feature and can turn the alternate link off, or opt in to the default theme's Copy as Markdown control. The companion is a byte-for-byte copy of the source file, including frontmatter. Draft and unlisted pages are never written. 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`
`notFound`optional	`boolean \| NotFoundOptions`	Write a themed 404 page during SSG. Off by default. `true` reads `404.md` from `srcDir` and writes `404.html`. An object enables the feature and overrides only the fields you set. When the source file is missing, a built-in "Page not found" page is written instead. The page is omitted from the search index and sitemap. Default `false`
`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`
`pageChrome`optional	`boolean \| Record<string, unknown>`	Honor per-page frontmatter chrome flags (`sidebar`, `outline` / `aside`, `footer`, `navbar`, `lastUpdated`, `editLink`). Disabled when omitted or `false`. `true` or `{}` enables the defaults: omitted flags keep current chrome, and `false` hides that region. Default `false`
`pagination`optional	`boolean \| Record<string, unknown>`	Show previous/next page links after the article. Disabled when omitted or `false`. `true` enables the default pager. An object also enables the feature. Default `false`
`readerChrome`optional	`boolean \| ReaderChromeOptions`	Opt-in copy buttons, outbound-link icons, and a back-to-top control. Disabled when omitted or `false`. `true` enables all three with defaults. An object enables the feature and can turn one control off, for example `{ copy: false }`. Bare pages and `ssg.render` custom themes can use the same copy and outbound-link transform without adopting the built-in theme. Default `false`
`render`optional	`ThemeComponent`	Render each page with a JSX theme component instead of the built-in renderer. The component owns the whole document, so `theme`, `bare` and the head metadata options do not apply — everything from `<html>` down is yours. `ssg.readerChrome`, when enabled, still post-processes the rendered document so custom themes share the built-in code-copy and outbound-link implementation. Compose one per layout with `createTheme()`, and read the current page through `usePageProps()` / `useSiteConfig()`. ```ts ssg: { render: createTheme({ layouts: { default: DefaultLayout } }) }``` Default `undefined`
`routePrefix`optional	`string`	Mount generated page routes under this path, independent from `base` and `outDir`. `blog`, `/blog`, and `/blog/` all mount under `/blog`. Page HTML and page-level assets follow the prefix. Root host files (`_redirects`, `_headers`, root feeds, sitemap index) stay at `outDir`. `base` remains the public deployment prefix and is not used as an output mount. Frontmatter `permalink` still wins when permalinks are enabled. Off when omitted. Default `undefined`
`sectionIndex`optional	`boolean \| SectionIndexOptions`	Generate a static index for directories that have child pages but no `index.md` / `index.mdx`. Off by default. `true` enables card listings. An object enables the feature and can switch the listing to `list`. Existing content indexes are never overwritten. Default `false`
`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`
`team`optional	`boolean \| TeamOptions`	Render a static members card grid on pages with `layout: team`. Off by default. `true` enables an empty list. An object enables the feature and supplies `members`. When the option is off, `layout: team` is ignored and the page stays ordinary. Default `false`
`theme`optional	`ThemeConfig \| 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. An array composes layers left to right, which is how a skin package and a color package are combined: ```ts theme: [pixelSkin, tokyoNight, { footer: { copyright: "2026" } }]``` Default `defaultTheme`
`transformConcurrency`optional	`number`	Maximum number of Markdown pages transformed at once during SSG. This overlaps independent page work such as build-time embed fetches while keeping network, memory, and file descriptor use bounded. Page rendering and writes still run through the deterministic output stages. Default `1`

interfaceSsgOutputPageInputOne host-owned page for composable SSG outputs (ssg: false). The host renders H…12 members

One host-owned page for composable SSG outputs (ssg: false).

The host renders HTML. Ox Content plans and emits resources, Markdown companions, feeds, and sitemap metadata from these fields.

Signature

export interface SsgOutputPageInput

View source

Members

Properties

Name	Type	Description
`description`optional	`string`
`draft`optional	`boolean`
`frontmatter`optional	`Record<string, unknown>`
`html`optional	`string`	Host-rendered HTML. Required for resource fingerprinting.
`inputPath`	`string`	Source file used for git lastmod and companion identity.
`lastUpdated`optional	`number`	Git commit time in milliseconds, or a host-supplied timestamp.
`loc`optional	`string`	Absolute page URL. When omitted, `siteUrl` + `base` + `urlPath` is used.
`outputPath`optional	`string`	Filesystem path of the host-rendered HTML page.
`source`optional	`string`	Already-read Markdown source bytes for companions.
`title`optional	`string`
`unlisted`optional	`boolean`
`urlPath`	`string`	Published URL path (`guide` or `/`).

interfaceStepsOptionsOptions for opt-in ::: steps ordered lists.1 member

Options for opt-in ::: steps ordered lists.

Signature

export interface StepsOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable the steps transform when an options object is supplied. Default `true`

interfaceTaxonomiesOptionsOpt-in term list pages, per-term pages, and related-page lists.2 members

Opt-in term list pages, per-term pages, and related-page lists.

Signature

export interface TaxonomiesOptions

View source

Members

Properties

Name	Type	Description
`relatedLimit`optional	`number`	Maximum related pages injected into a source page. Default `5`
`taxonomies`optional	`string[]`	Frontmatter keys (and URL prefixes) to read terms from. Default `["tags", "categories"]`

interfaceTeamLinkOne link on a team member card.2 members

One link on a team member card.

Signature

export interface TeamLink

View source

Members

Properties

Name	Type	Description
`href`	`string`	Destination. Only `https:` or a site-relative `/` path is emitted.
`label`	`string`	Visible label. Escaped in HTML.

interfaceTeamMemberOne person on the team page.4 members

One person on the team page.

Signature

export interface TeamMember

View source

Members

Properties

Name	Type	Description
`avatar`optional	`string`	Avatar URL. Only `https:` or a site-relative `/` path is emitted.
`links`optional	`TeamLink[]`	Optional profile or social links.
`name`	`string`	Display name. Escaped in HTML.
`role`optional	`string`	Optional role or title. Escaped in HTML.

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.

interfaceTimelineOptionsOptions for opt-in static timelines.5 members

Options for opt-in static timelines.

Signature

export interface TimelineOptions

View source

Members

Properties

Name	Type	Description
`empty`optional	`"error" \| "warn" \| "ignore"`	Diagnostics for timeline blocks without items. Default `"error"`
`enabled`optional	`boolean`	Enable `::: timeline` blocks. Default `true when the options object is supplied.`
`invalidDate`optional	`"error" \| "warn" \| "ignore"`	Diagnostics for malformed `YYYY`, `YYYY-MM`, or `YYYY-MM-DD` item dates. Default `"error"`
`ordered`optional	`boolean`	Render timelines as ordered lists unless a block overrides it. Default `true`
`unknownMeta`optional	`"error" \| "warn" \| "ignore"`	Diagnostics for unsupported item metadata. Default `"error"`

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.11 members

Transform result.

Signature

export interface TransformResult

View source

Members

Properties

Name	Type	Description
`bibliography`	`BibliographyEntry[]`	Bibliography entries used by this document.
`citations`	`CitationReference[]`	Citation references collected during the Markdown transform.
`code`	`string`	Generated JavaScript code.
`components`	`string[]`	Unique JSX component names in document order (empty when none).
`crossReferences`	`CrossReferenceEntry[]`	Labeled cross-reference targets collected during the Markdown transform.
`exports`	`string[]`	Export names from MDX ESM (empty when MDX is off or no exports).
`frontmatter`	`Record<string, unknown>`	Parsed frontmatter.
`html`	`string`	Rendered HTML.
`imports`	`MdxImport[]`	MDX `import` statements (empty when MDX is off or no ESM nodes).
`map`optional	`null`	Source map (null means no source map).
`toc`	`TocEntry[]`	Table of contents.

interfaceTypedHoverOptionsOptions for opt-in typed hover overlays on TypeScript fences. Hover strings are…3 members

Options for opt-in typed hover overlays on TypeScript fences.

Hover strings are computed at build time with the same TypeScript compiler family used by codeBlockTypecheck (tsgo / typescript). The browser only receives JSON payloads and a tiny overlay script.

Signature

export interface TypedHoverOptions

View source

Members

Properties

Name	Type	Description
`enabled`optional	`boolean`	Enable typed hover overlays. Default `true when the object form is used`
`languages`optional	`string[]`	Fence languages that can receive hover payloads. Language names are compared case-insensitively. Default `['ts', 'tsx']`
`tsgoCommand`optional	`string`	Path to the `tsgo` binary used to compute hover types. When omitted, the bundled `@typescript/native-preview` executable is used.

moduletypesType definitions for @ox-content/vite-plugin

Type definitions for @ox-content/vite-plugin

View source

typeVersionBannerKind = "unreleased" | "unmaintained"Banner shown on pages that belong to one documented version.

Banner shown on pages that belong to one documented version.

Signature

export type VersionBannerKind = "unreleased" | "unmaintained"

View source

interfaceVersionEntryOne published or snapshot version of a docs tree.5 members

One published or snapshot version of a docs tree.

Signature

export interface VersionEntry

View source

Members

Properties

Name	Type	Description
`banner`optional	`VersionBannerKind \| false`	Optional status banner for pages in this version.
`dir`optional	`string`	Snapshot directory relative to the Vite root. Omitted entries use the live `srcDir` and are not copied. Historical dirs are read-only.
`id`	`string`	Stable id used as `versions.current`.
`label`	`string`	Header label. Escaped before it is rendered.
`prefix`	`string`	URL prefix without slashes (`"2.90"`, `"next"`). Empty string is the site root.

interfaceVersionsOptionsOpt-in documentation versioning. Off by default. true enables a single current…4 members

Opt-in documentation versioning.

Off by default. true enables a single current entry. An object enables the feature and overrides only the fields you set.

Signature

export interface VersionsOptions

View source

Members

Properties

Name	Type	Description
`badge`optional	`boolean`	Show unreleased / unmaintained badges in the dropdown. @default true
`current`optional	`string`	Id of the live tree being built from `srcDir`.
`entries`optional	`VersionEntry[]`	Declared versions. Historical snapshots must set `dir`.
`switcher`optional	`boolean`	Render the header version dropdown. @default true

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`