A11yOptionsPer-control flags for ssg.a11y. Omitted fields keep the defaults when the featu…Per-control flags for ssg.a11y.
Omitted fields keep the defaults when the feature itself is enabled.
export interface A11yOptions| Name | Type | Description |
|---|---|---|
skipLinkLabeloptional |
string |
Visible label for the skip link. Escaped in HTML. Default "Skip to content" |
AbbreviationsOptionsOptions for opt-in abbreviation and glossary expansion.Options for opt-in abbreviation and glossary expansion.
export interface AbbreviationsOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable the transform when an options object is supplied. Default true |
firstUseOnlyoptional |
boolean |
Wrap only the first occurrence of each term. Default false |
termsoptional |
Record<string, string> |
Central glossary. Keys are matched with Unicode word boundaries. |
AttrsOptionsOptions for markdown-it-attrs style attribute blocks. Attribute blocks let auth…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}.
export interface AttrsOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
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 |
BadgeOptionsOptions for opt-in {badge:variant} inline badges.Options for opt-in {badge:variant} inline badges.
export interface BadgeOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable the badge transform when an options object is supplied. Default true |
BlogFeedFailurePolicy = "warn" | "error"How a failed external feed source is reported.How a failed external feed source is reported.
export type BlogFeedFailurePolicy = "warn" | "error"BlogFeedSourceOne configured external blog feed.One configured external blog feed.
export interface BlogFeedSource| Name | Type | Description |
|---|---|---|
authoroptional |
string |
Default author applied when an item omits one. |
languageoptional |
string |
Default language applied when an item omits one. |
onErroroptional |
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. |
BlogOptionsOpt-in blog index, authors, tags, reading time, and archive.Opt-in blog index, authors, tags, reading time, and archive.
export interface BlogOptions| Name | Type | Description |
|---|---|---|
authorsoptional |
Record<string, BlogAuthor> |
Author records keyed by the frontmatter author / authors value.Default {} |
collectionoptional |
string |
Named collection of posts. Defaults to a collection named blog, orthe only configured collection. Required when several collections exist and none is named blog. |
feedsoptional |
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 [] |
pageSizeoptional |
number |
Posts per index page, newest first. Default 10 |
BuiltinEmbedOptionsBuilt-in embed configuration.Built-in embed configuration.
export interface BuiltinEmbedOptions| Name | Type | Description |
|---|---|---|
appleMusicoptional |
boolean |
Render <AppleMusic url="https://music.apple.com/..."> iframes.Default false |
asciinemaoptional |
boolean |
Render <Asciinema> terminal-recording cards.Default false |
audiooptional |
boolean |
Render <Audio src="https://..."> native audio players.Default false |
blueskyoptional |
boolean |
Render <Bluesky> as static cards.Default false |
discordoptional |
boolean |
Render <Discord> as static invite/message cards.Default false |
facebookoptional |
boolean |
Render <Facebook> as static post cards.Default false |
fediverseoptional |
boolean |
Render <Fediverse>, <Mastodon>, <Misskey>, and <Mixi2> as static cards.Default false |
figmaoptional |
boolean |
Render <Figma> file, design, board, and prototype cards.Default false |
githuboptional |
boolean | GitHubOptions |
Render <GitHub repo="owner/name" /> repository cards.Pass an options object to configure fetching. Default true |
googleMapsoptional |
boolean |
Render <GoogleMaps> as static place cards.Default false |
googleSlidesoptional |
boolean |
Render <GoogleSlides> deck cards.Default false |
instagramoptional |
boolean |
Render <Instagram> as static post cards.Default false |
loomoptional |
boolean |
Render <Loom> recording cards.Default false |
noteoptional |
boolean |
Render <Note> note.com article cards.Default false |
openGraphoptional |
boolean | OgpOptions |
Render <OgCard url="https://example.com" /> Open Graph link cards.Pass an options object to configure fetching. Default true |
packageRegistryoptional |
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 |
playgroundsoptional |
boolean | ProviderPlaygroundEmbedOptions |
Render <CodePen>, <JSFiddle>, and <Observable> as static playground cards.Pass { iframe: true } to include lazy iframe URLs where supported.Default false |
pmoptional |
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 inevery other package-manager block on the page (persisted in localStorage). Default false |
qiitaoptional |
boolean | ProviderArticleEmbedOptions |
Render <Qiita> as static article cards.Pass { fetch: false } to skip metadata fetching and render a link-only card.Default false |
redditoptional |
boolean | RedditEmbedOptions |
Render <Reddit> as a static post card.Pass { fetch: false } to skip metadata fetching and render a link-only card.Default false |
speakerDeckoptional |
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 |
spotifyoptional |
boolean |
Render <Spotify url="https://open.spotify.com/track/..."> iframes.Default false |
stackBlitzoptional |
boolean |
Render <StackBlitz url="https://stackblitz.com/edit/..."> iframes.Default false |
threadsoptional |
boolean |
Render <Threads> as static post cards.Default false |
twitchoptional |
boolean | ProviderVideoEmbedOptions |
Render <Twitch> as static video, clip, and channel cards.Pass { iframe: true, parent: "example.com" } to include Twitch iframes.Default false |
twitteroptional |
boolean | TwitterEmbedOptions |
Render <Tweet> / <XPost> as static privacy-conscious cards.Pass { fetch: true } to fetch the post body, author, and self-hostedmedia at build time. Fetch failures fall back to the link-only card. Default false |
videooptional |
boolean |
Render <Video src="https://..."> native video players.Default false |
vimeooptional |
boolean | ProviderVideoEmbedOptions |
Render <Vimeo> as static video cards.Pass { iframe: true } to include lazy player iframe URLs.Default false |
webContaineroptional |
boolean |
Render <WebContainer> lazy placeholders with isolation metadata.Default false |
zennoptional |
boolean | ProviderArticleEmbedOptions |
Render <Zenn> as static article cards.Pass { fetch: false } to skip metadata fetching and render a link-only card.Default false |
BuiltinPmOptionsOptions for the package-manager install-tab transform.Options for the package-manager install-tab transform.
export interface BuiltinPmOptions| Name | Type | Description |
|---|---|---|
syncoptional |
boolean |
Enable opt-in synced package-manager tab groups. Default false |
CardOptionsOptions for opt-in ::: card / ::: link-card / ::: card-grid blocks.Options for opt-in ::: card / ::: link-card / ::: card-grid blocks.
export interface CardOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable the card transform when an options object is supplied. Default true |
CascadeOptionsOpt-in _index directory frontmatter cascade. false or omitted stays off. true o…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.
export interface CascadeOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable directory-level frontmatter inheritance. Default true |
CodeAnnotationKind = "highlight" | "warning" | "error"Supported line annotation kinds for code blocks.Supported line annotation kinds for code blocks.
export type CodeAnnotationKind = "highlight" | "warning" | "error"CodeAnnotationsOptionsOpt-in code annotation configuration.Opt-in code annotation configuration.
export interface CodeAnnotationsOptions| Name | Type | Description |
|---|---|---|
defaultLineNumbersoptional |
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 |
metaKeyoptional |
string |
Attribute name read from the code fence meta string. Example: annotate="highlight:1,3-4;warning:6"Default "annotate" |
notationoptional |
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 syntaxesDefault "attribute" |
CodeAnnotationSyntax = "attribute" | "vitepress" | "both"Supported code annotation syntaxes.Supported code annotation syntaxes.
export type CodeAnnotationSyntax = "attribute" | "vitepress" | "both"CodeBlockLintOptionsOptions for linting fenced code blocks during Markdown transforms. These checks…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.
export interface CodeBlockLintOptions| Name | Type | Description |
|---|---|---|
languagesoptional |
string[] |
Languages to lint. Omit to lint every fenced block language. Language names are compared case-insensitively. Default undefined |
modeoptional |
"warn" | "error" |
Diagnostic severity for lint failures. Use 'error' when code-block lint failures should fail the build.Default 'warn' |
requireLanguageoptional |
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 |
trailingSpacesoptional |
boolean |
Report trailing whitespace inside fenced code blocks. The check reports the exact line and column range inside the fence content. Default true |
CodeBlockTypecheckOptionsOptions for type-checking TypeScript and TSX fenced code blocks. Type-checking…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.
export interface CodeBlockTypecheckOptions| Name | Type | Description |
|---|---|---|
languagesoptional |
string[] |
Fence languages to type-check. Language names are compared case-insensitively. Default ['ts', 'tsx'] |
modeoptional |
"warn" | "error" |
Diagnostic severity for type-check failures. Use 'error' to fail the Markdown transform on broken snippets.Default 'warn' |
requireMetaoptional |
boolean |
Require an opt-in fence meta marker before type-checking. When enabled, only fences with metadata such as typecheck or twoslashare checked. Default true |
tsgoCommandoptional |
string |
Command used to run the TypeScript checker. Override this for package-manager scripts or workspace-local binaries. Default 'tsgo' |
CodeGroupOptionsOptions for opt-in ::: code-group fence groups.Options for opt-in ::: code-group fence groups.
export interface CodeGroupOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable the code-group transform when an options object is supplied. Default true |
CodeImportOptionsOptions for importing source snippets into code fences. The transform resolves…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.
export interface CodeImportOptions| Name | Type | Description |
|---|---|---|
rootDiroptional |
string |
Directory used to resolve <<< imports.When omitted, imports resolve from the Vite project root and configured aliases. Default undefined |
CollectionEntryQueryable Markdown collection entry.Queryable Markdown collection entry.
export interface CollectionEntry[key: string]: unknown| Name | Type | Description |
|---|---|---|
bodyoptional |
string |
|
collection |
string |
|
descriptionoptional |
string |
|
extension |
string |
|
frontmatter |
Record<string, unknown> |
|
htmloptional |
string |
|
id |
string |
|
path |
string |
|
source |
string |
|
stem |
string |
|
title |
string |
|
tocoptional |
TocEntry[] |
CollectionIncludeField = "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.
export type CollectionIncludeField = "body" | "html" | "toc"CollectionManifestGenerated collection manifest.Generated collection manifest.
export interface CollectionManifest| Name | Type | Description |
|---|---|---|
collections |
Record<string, CollectionEntry[]> |
CollectionOptionsCollection source configuration.Collection source configuration.
export interface CollectionOptions| Name | Type | Description |
|---|---|---|
includeoptional |
readonly CollectionIncludeField[] |
Optional fields to include in each entry. The default is metadata-only for performance. Use body for stripped rawMarkdown, html for native rendered HTML, and toc for the parsed tableof contents. Default [] |
sourceoptional |
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 |
validateoptional |
CollectionValidateHook |
Validate a parsed collection document during manifest generation. Return a string or an array of strings to mark the document invalid. Return nothing, null, or false to accept it. path and stem are thefile-tree route values before permalink / cascade rewrites so validators can compare frontmatter permalink values against the source layout.
|
CollectionsOptions = Record<string, CollectionOptions | string | readonly string[]>Top-level collection definitions.Top-level collection definitions.
export type CollectionsOptions = Record<string, CollectionOptions | string | readonly string[]>ConditionalBlockOptionsOptions for opt-in static conditional blocks.Options for opt-in static conditional blocks.
export interface ConditionalBlockOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable ::: if / ::: else blocks.Default true when the options object is supplied. |
valuesoptional |
Record<string, unknown> |
Build-time values available as config.* or bare identifiers. Pagefrontmatter wins for bare identifiers; use config.name to force config. |
ContainerOptionsOptions for opt-in ::: type custom containers.Options for opt-in ::: type custom containers.
export interface ContainerOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable the container transform when an options object is supplied. Default true |
typesoptional |
Record<string, ContainerTypeOptions> |
Extra or overriding container types. Keys must be ASCII identifiers ( [A-Za-z0-9_-]+). Unknown hostile namesare ignored. |
ContainerTypeOptionsPer-type container presentation.Per-type container presentation.
export interface ContainerTypeOptions| Name | Type | Description |
|---|---|---|
tagoptional |
"div" | "details" |
"details" renders <details>/<summary>; anything else is a <div>. |
titleoptional |
string |
Title used when the opener does not set one. |
ContributorsOptionsOpt-in git contributor list.Opt-in git contributor list.
export interface ContributorsOptions| Name | Type | Description |
|---|---|---|
avatarsoptional |
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. |
ignoreoptional |
string[] |
Author names or emails to omit. Comparison is case-insensitive and matches the full name or the full email. |
DataTableOptionsOptions for opt-in csv-table / json-table fences.Options for opt-in csv-table / json-table fences.
export interface DataTableOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable the data-table transform when an options object is supplied. Default true |
missingoptional |
"error" | "warn" |
What to do when an imported CSV/JSON file is missing. Default "error" |
rootDiroptional |
string |
Directory used to resolve @/ and absolute import paths.When omitted, imports resolve from the Vite project root. Default undefined |
DefinitionListOptionsOptions for opt-in PHP Markdown Extra / mdBook-style definition lists.Options for opt-in PHP Markdown Extra / mdBook-style definition lists.
export interface DefinitionListOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable the definition-list transform when an options object is supplied. Default true |
DocEntryA single documentation entry extracted from source. Entries represent top-level…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.
export interface DocEntry| 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. |
examplesoptional |
string[] |
Code examples collected from @example tags. |
extendsoptional |
string[] |
Extended base class or interface names. |
file |
string |
Source file path relative to the extraction root when available. |
hasBodyoptional |
boolean |
Whether a function declaration has a body ( false for overload signatures). |
implementsoptional |
string[] |
Implemented interface names. |
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. |
membersoptional |
DocMember[] |
Members belonging to classes, interfaces, object types, and enums. |
name |
string |
Exported or declared symbol name. |
paramsoptional |
ParamDoc[] |
Function, method, or constructor parameter documentation. |
privateoptional |
boolean |
True when the entry is marked private or matched by private filtering. |
returnsoptional |
ReturnDoc |
Return value documentation for callable declarations. |
signatureoptional |
string |
Full declaration signature, when the renderer can extract one. |
tagListoptional |
DocTag[] |
Every additional tag in source order, with each value of a repeated tag. The generated docs use it instead of tags. |
tagsoptional |
Record<string, string> |
Additional tags by tag name after known tags are normalized, with the first value of a repeated tag. |
throwsoptional |
ThrowsDoc[] |
Exceptions/errors documented with @throws / @exception. |
typeParametersoptional |
TypeParamDoc[] |
Declaration type parameters, extracted when typeParameters is enabled. |
DocMemberA member belonging to a class, interface, type alias, or enum entry.A member belonging to a class, interface, type alias, or enum entry.
export interface DocMember| Name | Type | Description |
|---|---|---|
defaultoptional |
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. |
optionaloptional |
boolean |
True when the member is optional in the source declaration. |
paramsoptional |
ParamDoc[] |
Parameter documentation for methods and constructors. |
privateoptional |
boolean |
True when the member is marked private or matched by private filtering. |
readonlyoptional |
boolean |
True when the member is declared readonly. |
returnsoptional |
ReturnDoc |
Return value documentation for methods and accessors. |
signatureoptional |
string |
Full member signature, when available. |
staticoptional |
boolean |
True when the member is static. |
tagListoptional |
DocTag[] |
Every additional tag in source order, with each value of a repeated tag. The generated docs use it instead of tags. |
tagsoptional |
Record<string, string> |
Additional tags by tag name after known tags are normalized, with the first value of a repeated tag. |
throwsoptional |
ThrowsDoc[] |
Exceptions/errors documented with @throws / @exception. |
typeoptional |
string |
Rendered TypeScript type text for properties and enum members. |
DocsEntryPoint = string | { path: string; name?: string }Public API entry point for grouped documentation.Public API entry point for grouped documentation.
export type DocsEntryPoint = string | { path: string; name?: string }DocsOptionsOptions for source documentation generation. The generator extracts JSDoc/TSDoc…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.
export interface DocsOptions| Name | Type | Description |
|---|---|---|
basePathoptional |
string |
Route prefix used by generated documentation links and nav metadata. Nav metadata falls back to /api when this is not set.Default undefined |
classPropertiesFormatoptional |
MarkdownDisplayFormat |
Display format for class property groups. Default 'none' |
enabledoptional |
boolean |
Enable source documentation generation. The top-level docs option is opt-out: omitting it enables docs generationwith defaults, while docs: false disables the docs plugin entirely.Default true |
entryPointsoptional |
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 |
enumMembersFormatoptional |
MarkdownDisplayFormat |
Display format for enum member groups. Default 'none' |
excludeoptional |
string[] |
Glob patterns for files to exclude. Excludes run after include matching and should cover tests, generatedfiles, and implementation-only entry points. Default ['**\/*.test.*', '**\/*.spec.*', 'node_modules'] |
formatoptional |
"markdown" | "json" | "html" |
Output format. markdown is the primary supported format. json and html are reservedfor consumers that want to post-process extracted documentation data. Default 'markdown' |
generateNavoptional |
boolean |
Generate navigation metadata file. Default true |
githubUrloptional |
string |
GitHub repository URL for source code links. When provided, generated documentation includes links back to the source declaration lines. Default undefined |
groupByoptional |
"file" | "category" |
Group documentation by file or category. Default 'file' |
groupOrderoptional |
string[] |
TypeDoc-style group order for module index sections and nav groups. Use * as the insertion point for unlisted groups.Default undefined |
includeoptional |
string[] |
Glob patterns for files to include. Patterns are evaluated inside each src directory.Default ['**\/*.ts', '**\/*.tsx', '**\/*.js', '**\/*.jsx', '**\/*.mts', '**\/*.mjs', '**\/*.cts', '**\/*.cjs'] |
indexFormatoptional |
MarkdownDisplayFormat |
Display format for index items. Default 'none' |
interfacePropertiesFormatoptional |
MarkdownDisplayFormat |
Display format for interface property groups. Default 'none' |
internaloptional |
boolean |
Include internal members in documentation. Default false |
kindSortOrderoptional |
string[] |
TypeDoc-style declaration kind ranking for module sections and nav groups. Default undefined |
linkStyleoptional |
"markdown" | "clean" |
Internal documentation link style. Use markdown for generated .md targets and clean for route-style linksconsumed by static-site frameworks. Default 'markdown' |
openapioptional |
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 sameMarkdown, stale-file cleanup, SSG, and search pipeline as source docs. Default false |
outoptional |
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' |
parametersFormatoptional |
MarkdownDisplayFormat |
Display format for value and type parameters. Default 'none' |
pathStrategyoptional |
"flat" | "typedoc" |
Generated Markdown output path strategy. flat emits one page per source module or category. typedoc emitsTypeDoc-like module, kind, and symbol pages for larger API references. Default 'flat' |
privateoptional |
boolean |
Include private members in documentation. Default false |
propertyMembersFormatoptional |
MarkdownDisplayFormat |
Display format for property-owned object literal members. Default 'none' |
renderGeneratedByoptional |
boolean |
Emit the generated-by attribution on generated root index pages. Default true |
renderStatsoptional |
boolean |
Emit the stats summary line on generated index pages. Default true |
renderStyleoptional |
"html" | "markdown" |
Rendering style for generated API Markdown. - 'html' (default): HTML-laced Markdown with collapsible entries, statblocks and member tables (ox-content theme). - 'markdown': pure Markdown (headings, tables, fenced code) with no rawHTML scaffolding, suitable for plain Markdown hosts such as VitePress. Default 'html' |
singleEntryRootoptional |
"preserve" | "flatten" |
Single-entry root handling for TypeDoc-style generated docs. When set to 'flatten', a single TypeDoc entry point uses the rootindex.md as its landing page and omits the extra module level fromgenerated nav metadata. Symbol page paths stay under the entry point. Default 'preserve' |
sortoptional |
DocsSortStrategy[] |
TypeDoc-style sort strategies applied to entries and members. Strategies run in order; later strategies break ties from earlier ones. Default undefined |
sortEntryPointsoptional |
boolean |
Preserve caller-provided entry point order when false. Default true |
srcoptional |
string[] |
Source directories to scan for documentation. Paths are resolved from the Vite project root before applying include andexclude patterns.Default ['./src'] |
tocoptional |
boolean |
Generate table of contents for each file. Reserved for future use; current generated API pages do not emit this TOC. Default false |
typeAliasPropertiesFormatoptional |
MarkdownDisplayFormat |
Display format for type alias property groups. Default 'none' |
typeDeclarationFormatoptional |
MarkdownDisplayFormat |
Display format for return type declaration members. Default 'none' |
typeParametersoptional |
boolean |
Opt in to TSDoc-style type-parameter documentation. When enabled, declaration type parameters ( <T extends C = D>) areextracted 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 |
DocsSummarySummary counts emitted with generated documentation data.Summary counts emitted with generated documentation data.
export interface DocsSummary| 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. |
DocsTestOptionsOptions for extracting fenced examples into docs-as-tests fixtures. The extract…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.
export interface DocsTestOptions| Name | Type | Description |
|---|---|---|
languagesoptional |
string[] |
Fence languages to collect as runnable examples. Language names are compared case-insensitively. Default ['js', 'jsx', 'ts', 'tsx'] |
requireMetaoptional |
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 |
DocTagA JSDoc tag with its value, such as @see https://example.com.A JSDoc tag with its value, such as @see https://example.com.
export interface DocTag| Name | Type | Description |
|---|---|---|
tag |
string |
Tag name without @. |
value |
string |
Tag value. |
EditThisPageOptionsOptions for appending an "edit this page" link. The generated link points at th…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.
export interface EditThisPageOptions| Name | Type | Description |
|---|---|---|
branchoptional |
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' |
labeloptional |
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' |
provideroptional |
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 sourceview, Gitea and Forgejo use _edit — so a site on the wrong shape linksto 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 hostnamesays 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. |
rootDiroptional |
string |
Source root inside the repository, used before the page path. Set this when srcDir is nested in a package or docs workspace: thevalue says where srcDir lives inside the repository, and the pagepath is measured from srcDir rather than from the directory the buildruns in. Default undefined |
urlPatternoptional |
string |
Edit-URL template, for a forge or an instance the shapes above miss. Understands {repoUrl}, {branch}, and {path}; other braces areleft as written. Takes precedence over provider.Default the pattern for the resolved `provider` |
EditThisPageProvider = "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.
export type EditThisPageProvider = "github" | "gitlab" | "bitbucket" | "gitea"EmojiShortcodeOptionsOptions for expanding :shortcode: emoji aliases. The transform replaces recogni…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.
export interface EmojiShortcodeOptions| Name | Type | Description |
|---|---|---|
customoptional |
Record<string, string> |
Custom shortcode map merged with the built-in emoji aliases. Keys should omit the surrounding colons. Default {} |
EntryPageConfigEntry page frontmatter configuration.Entry page frontmatter configuration.
export interface EntryPageConfig| Name | Type | Description |
|---|---|---|
featuresoptional |
FeatureConfig[] |
Feature cards |
herooptional |
HeroConfig |
Hero section |
layout |
"entry" |
Layout type - set to 'entry' for entry page |
ExtractedDocsExtracted documentation for a single file.Extracted documentation for a single file.
export interface ExtractedDocs| Name | Type | Description |
|---|---|---|
descriptionoptional |
string |
Optional module-level description extracted from a file header comment. |
entries |
DocEntry[] |
Top-level documented declarations found in this module. |
examplesoptional |
string[] |
Module-level examples collected from a file header comment. |
file |
string |
Source module or file identifier used by generated output. |
sourcePathoptional |
string |
Absolute source path, when available for source links and diagnostics. |
tagListoptional |
DocTag[] |
Every module-level tag in source order, with each value of a repeated tag. The generated docs use it instead of tags. |
tagsoptional |
Record<string, string> |
Module-level tags by tag name, with the first value of a repeated tag. |
FeatureConfigFeature card for entry page.Feature card for entry page.
export interface FeatureConfig| Name | Type | Description |
|---|---|---|
detailsoptional |
string |
Feature description |
iconoptional |
string |
Icon - supports: "mdi:icon-name" (Iconify), image URL, or emoji |
linkoptional |
string |
Optional link |
linkTextoptional |
string |
Link text |
title |
string |
Feature title |
FeedChannelOptionsOne feed's formats, source, output path, and channel metadata.One feed's formats, source, output path, and channel metadata.
export interface FeedChannelOptions| Name | Type | Description |
|---|---|---|
collectionoptional |
string |
Named collection to publish. Defaults to content, or the firstconfigured collection when content is absent. |
copyrightoptional |
string |
Copyright / rights notice. Omitted from JSON Feed. |
descriptionoptional |
string |
Channel description. Defaults to the SSG site description. |
faviconoptional |
string |
Favicon URL (Atom icon / JSON Feed favicon). |
formatsoptional |
readonly FeedFormat[] |
Feed formats to write. Default ["rss", "atom", "json"] |
imageoptional |
string |
Channel image URL (RSS image / Atom logo / JSON Feed icon). |
itemsoptional |
FeedItemsSource |
Programmatic items for this channel. A channel may set either collection or items, not both. |
languageoptional |
string |
Channel language ( en, ja, …). Omitted when unset. |
limitoptional |
number |
Maximum number of published items, newest first. Default 20 |
pathoptional |
string |
Site-relative directory for the generated files. Default "/" |
titleoptional |
string |
Channel title. Defaults to the SSG site name. |
FeedFormat = "rss" | "atom" | "json"Feed file formats written during SSG.Feed file formats written during SSG.
export type FeedFormat = "rss" | "atom" | "json"FeedItemAttachmentOne JSON Feed / enclosure attachment accepted by programmatic feeds.One JSON Feed / enclosure attachment accepted by programmatic feeds.
export interface FeedItemAttachment| Name | Type | Description |
|---|---|---|
durationInSecondsoptional |
number |
|
mimeTypeoptional |
string |
|
sizeInBytesoptional |
number |
|
titleoptional |
string |
|
url |
string |
FeedItemInputOne collection or programmatic item considered for a generated feed.One collection or programmatic item considered for a generated feed.
export interface FeedItemInput| Name | Type | Description |
|---|---|---|
attachmentsoptional |
readonly FeedItemAttachment[] |
|
authoroptional |
FeedItemAuthorInput |
|
authorsoptional |
readonly FeedItemAuthorInput[] |
|
contentoptional |
string |
|
dateoptional |
unknown |
|
descriptionoptional |
string |
|
draftoptional |
unknown |
|
frontmatteroptional |
Record<string, unknown> |
|
idoptional |
string |
|
imageoptional |
string |
|
languageoptional |
string |
|
lastUpdatedoptional |
unknown |
|
locoptional |
string |
|
pathoptional |
string |
|
titleoptional |
string |
|
unlistedoptional |
unknown |
|
urloptional |
string |
FeedsOptions = 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.
export type FeedsOptions = FeedChannelOptions | readonly FeedChannelOptions[] | { [name: string]: FeedChannelOptions }FileTreeIconOptionsReplaceable file-tree icons. Values are trusted site-config SVG markup or CSS c…Replaceable file-tree icons. Values are trusted site-config SVG markup or CSS class tokens, never fence content.
export interface FileTreeIconOptions| Name | Type | Description |
|---|---|---|
fileoptional |
string |
Default file icon. |
filesoptional |
Record<string, string> |
File icons keyed by extension ( ts, .json). |
folderoptional |
string |
Collapsed folder icon. |
folderOpenoptional |
string |
Open folder icon. |
FileTreeOptionsOptions for opt-in file-tree fences.Options for opt-in file-tree fences.
export interface FileTreeOptions| Name | Type | Description |
|---|---|---|
defaultOpenoptional |
boolean |
Open directory <details> by default.Default true |
enabledoptional |
boolean |
Enable the file-tree transform when an options object is supplied. Default true |
iconsoptional |
boolean | FileTreeIconOptions |
Render folder and file icons. Pass an object to replace the defaults. Default true |
GeneratedDocsDataMachine-readable payload emitted alongside generated docs.Machine-readable payload emitted alongside generated docs.
export interface GeneratedDocsData| 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. |
GeneratedOpenApiDocsGenerated OpenAPI Markdown pages and sidebar metadata.Generated OpenAPI Markdown pages and sidebar metadata.
export interface GeneratedOpenApiDocs| Name | Type | Description |
|---|---|---|
nav |
DocsNavigationItem[] |
|
pages |
Record<string, string> |
HeadingPermalinksOptionsOpt-in visible heading permalinks. Headings already have stable ids. Enabling t…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.
export interface HeadingPermalinksOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Emit the permalink control. Default true |
HeroActionHero section action button.Hero section action button.
export interface HeroAction| Name | Type | Description |
|---|---|---|
link |
string |
Link URL |
text |
string |
Button text |
themeoptional |
"brand" | "alt" |
Button theme: 'brand' (primary) or 'alt' (secondary) |
HeroConfigHero section configuration for entry page.Hero section configuration for entry page.
export interface HeroConfig| Name | Type | Description |
|---|---|---|
actionsoptional |
HeroAction[] |
Action buttons |
imageoptional |
HeroImage |
Hero image |
nameoptional |
string |
Main title (large, gradient text) |
noticeoptional |
HeroNotice |
Notice shown near the top of the hero |
taglineoptional |
string |
Tagline (smaller, muted) |
textoptional |
string |
Secondary text (medium size) |
HeroImageHero section image configuration.Hero section image configuration.
export interface HeroImage| Name | Type | Description |
|---|---|---|
altoptional |
string |
Alt text |
darkSrcoptional |
string |
Dark mode image source URL |
heightoptional |
number |
Image height |
lightSrcoptional |
string |
Light mode image source URL |
src |
string |
Image source URL |
widthoptional |
number |
Image width |
HeroNoticeHero notice configuration.Hero notice configuration.
export interface HeroNotice| Name | Type | Description |
|---|---|---|
bodyoptional |
string[] |
Notice paragraphs |
titleoptional |
string |
Notice title |
I18nOptionsi18n (internationalization) options. i18n is opt-in because it changes routing…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.
export interface I18nOptions| Name | Type | Description |
|---|---|---|
checkoptional |
boolean |
Run i18n checks during build. Checks validate dictionary coverage and translation function usage when the native i18n checker is available. Default true |
defaultLocaleoptional |
string |
Default locale tag. The default locale is added to locales automatically when omitted from thelist. Default 'en' |
diroptional |
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' |
enabledoptional |
boolean |
Enable i18n. The resolver returns false unless this is explicitly set to true.Default false |
functionNamesoptional |
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'] |
hideDefaultLocaleoptional |
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 |
localesoptional |
LocaleConfig[] |
Available locales. When omitted, ox-content creates a single locale from defaultLocale.Default [{ code: defaultLocale, name: defaultLocale }] |
IconsOptionsOpt-in self-hosted Iconify CSS for used icons. Off by default. When enabled, th…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.
export interface IconsOptions| Name | Type | Description |
|---|---|---|
includeoptional |
string[] |
Glob patterns to scan, or explicit prefix:name icons.Entries that look like Iconify names are used as-is (no scan). |
modeoptional |
"css-mask" |
CSS emission mode. Default "css-mask" |
safelistoptional |
string[] |
Iconify names that are always emitted, even when no source mentions them. |
syntaxoptional |
"unocss" |
Class syntax. "unocss" emits icon-[prefix--name].Default "unocss" |
ImageGalleryOptionsOptions for opt-in static image galleries.Options for opt-in static image galleries.
export interface ImageGalleryOptions| Name | Type | Description |
|---|---|---|
emptyoptional |
"error" | "warn" | "ignore" |
Diagnostics for galleries without image items. Default "error" |
enabledoptional |
boolean |
Enable ::: gallery blocks.Default true when the options object is supplied. |
lazyoptional |
boolean |
Add loading="lazy" to gallery images.Default follows `images.lazy`, or true when `images` is disabled. |
missingAltoptional |
"error" | "warn" | "ignore" |
Diagnostics for image items without alt text. Default "error" |
ImageOptionsOptions for opt-in figures, captions, and lazy images.Options for opt-in figures, captions, and lazy images.
export interface ImageOptions| Name | Type | Description |
|---|---|---|
lazyoptional |
boolean |
Add loading="lazy" to transformed images.Default true |
IncludeOptionsOptions for inlining Markdown files with <!-- @include: PATH -->. Relative path…Options for inlining Markdown files with <!-- @include: PATH -->.
Relative paths resolve from the current file. @/ and leading / resolve from rootDir. After canonicalize, paths outside rootDir are rejected.
export interface IncludeOptions| Name | Type | Description |
|---|---|---|
rootDiroptional |
string |
Directory used to resolve @/ and absolute include paths.When omitted, includes resolve from the Vite project root. Default undefined |
JsonLdOptionsPer-control flags for ssg.jsonLd. Omitted fields keep the defaults when the fea…Per-control flags for ssg.jsonLd.
Omitted fields keep the defaults when the feature itself is enabled.
export interface JsonLdOptions| Name | Type | Description |
|---|---|---|
breadcrumbsoptional |
boolean |
Emit BreadcrumbList when a visible breadcrumb trail exists.Default true |
graphoptional |
Record<string, unknown>[] |
Extra @graph nodes. Only objects are kept. The build does not inventfields inside them. |
publisheroptional |
JsonLdPublisherOptions |
Optional publisher. Only configured name / url are written.Logo and other Organization fields are never invented. |
typeoptional |
JsonLdPageType |
Page @type. Defaults to TechArticle. |
JsonLdPageType = "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.
export type JsonLdPageType = "TechArticle" | "BlogPosting" | "WebPage"JsonLdPublisherOptionsOptional JSON-LD publisher. Empty or omitted fields are left out.Optional JSON-LD publisher. Empty or omitted fields are left out.
export interface JsonLdPublisherOptions| Name | Type | Description |
|---|---|---|
nameoptional |
string |
Organization name. |
urloptional |
string |
Organization URL. javascript: and other unsafe schemes are dropped. |
KatexFontFormats = "woff2" | "all"Which of KaTeX's font formats to emit.Which of KaTeX's font formats to emit.
export type KatexFontFormats = "woff2" | "all"KeyboardKeysOptionsOptions for opt-in {kbd:...} inline keyboard keys.Options for opt-in {kbd:...} inline keyboard keys.
export interface KeyboardKeysOptions| Name | Type | Description |
|---|---|---|
aliasesoptional |
Record<string, string> |
Build-time aliases. Keys are matched case-insensitively and override the built-in cmd / ctrl table. |
enabledoptional |
boolean |
Enable the keyboard-key transform when an options object is supplied. Default true |
styleoptional |
"words" | "symbols" |
Built-in alias labels. "words" emits Command; "symbols" emits ⌘.Default "words" |
LocaleConfigLocale configuration. Locales define the routing and display metadata used by t…Locale configuration.
Locales define the routing and display metadata used by the i18n plugin.
export interface LocaleConfig| Name | Type | Description |
|---|---|---|
code |
string |
BCP 47 locale tag (e.g., 'en', 'ja', 'zh-Hans'). |
diroptional |
"ltr" | "rtl" |
Text direction for rendered pages. Default 'ltr' |
name |
string |
Display name for this locale (e.g., 'English', '日本語'). |
MagicLinkAliasOne configured magic-link target.One configured magic-link target.
export interface MagicLinkAlias| Name | Type | Description |
|---|---|---|
href |
string |
|
imageoptional |
string |
|
labeloptional |
string |
MagicLinkImageOverrideReplace the image for an exact href or prefix.Replace the image for an exact href or prefix.
export interface MagicLinkImageOverride| Name | Type | Description |
|---|---|---|
hrefoptional |
string |
|
image |
string |
|
prefixoptional |
string |
MagicLinkOptionsOptions for opt-in {link:...} rich magic links.Options for opt-in {link:...} rich magic links.
export interface MagicLinkOptions| Name | Type | Description |
|---|---|---|
aliasesoptional |
Record<string, string | MagicLinkAlias> |
Named aliases. A string value is treated as { href }. |
enabledoptional |
boolean |
Enable the magic-link transform when an options object is supplied. Default true |
faviconoptional |
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 |
imageOverridesoptional |
MagicLinkImageOverride[] |
Replace the resolved image for matching hrefs. |
MarkdownNodeMarkdown AST node (simplified for TypeScript).Markdown AST node (simplified for TypeScript).
export interface MarkdownNode[key: string]: unknown| Name | Type | Description |
|---|---|---|
childrenoptional |
MarkdownNode[] |
|
type |
string |
|
valueoptional |
string |
MarkdownSourceOptionsOpt-in Markdown source companions written beside generated HTML.Opt-in Markdown source companions written beside generated HTML.
export interface MarkdownSourceOptions| Name | Type | Description |
|---|---|---|
alternateoptional |
boolean |
Add <link rel="alternate" type="text/markdown"> to generated HTML.Default true |
copyoptional |
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 |
MarkdownTransformerCustom AST transformer.Custom AST transformer.
export interface MarkdownTransformer| Name | Type | Description |
|---|---|---|
name |
string |
Transformer name. |
transform |
(ast: MarkdownNode, context: TransformContext) => MarkdownNode | Promise<MarkdownNode> |
Transform function.
|
MathErrorPolicy = "literal" | "error" | "render"What to do with a $…$ run KaTeX cannot parse.What to do with a $…$ run KaTeX cannot parse.
export type MathErrorPolicy = "literal" | "error" | "render"MathOptionsOptions for opt-in $…$ / $$…$$ math. Delimiter parsing lives in the native tran…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.
export interface MathOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable the math transform when an options object is supplied. Default true |
fontFormatsoptional |
KatexFontFormats |
Which KaTeX font formats to emit into the output directory. .ttf and .woff are three quarters of KaTeX's font bytes, and nobrowser that can run the rest of the site needs them — @font-facelists 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' |
onErroroptional |
MathErrorPolicy |
What to do with a $…$ run KaTeX cannot parse.The $…$ heuristics are good but not perfect, and a page about mathsyntax 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, delimitersincluded, and warns. - 'error' fails the build.- 'render' emits KaTeX's own red error markup, which is what thefeature did before this option existed. Default 'literal' |
MdxImportOne MDX import statement collected from the AST.One MDX import statement collected from the AST.
export interface MdxImport| Name | Type | Description |
|---|---|---|
source |
string |
Module specifier string. |
specifiers |
MdxImportSpecifier[] |
Bindings created by the import. |
MdxImportSpecifierOne binding created by an MDX import statement.One binding created by an MDX import statement.
export interface MdxImportSpecifier| Name | Type | Description |
|---|---|---|
imported |
string |
Imported name ( default, *, or the named export). |
kind |
MdxImportSpecifierKind |
Specifier kind. |
local |
string |
Local binding name. |
MdxImportSpecifierKind = "default" | "named" | "namespace"How a specifier was imported from an MDX import statement.How a specifier was imported from an MDX import statement.
export type MdxImportSpecifierKind = "default" | "named" | "namespace"NotByAiOptionsOptions for the opt-in <NotByAI /> authorship badge.Options for the opt-in <NotByAI /> authorship badge.
export interface NotByAiOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable the badge transform when an options object is supplied. Default true |
hrefoptional |
string |
Destination URL. Unsafe values fall back to https://notbyai.fyi.Default "https://notbyai.fyi" |
labeloptional |
string |
Accessible label for the badge link. Default "Written by human, not by AI" |
NotFoundOptionsOpt-in custom 404 page written during SSG.Opt-in custom 404 page written during SSG.
export interface NotFoundOptions| Name | Type | Description |
|---|---|---|
outputoptional |
string |
Output file relative to outDir.Default "404.html" |
sourceoptional |
string |
Markdown source relative to srcDir.Default "404.md" |
OgImageOptionsOG image generation options. Uses Chromium or Satori rendering with customizabl…OG image generation options. Uses Chromium or Satori rendering with customizable templates.
export interface OgImageOptions| Name | Type | Description |
|---|---|---|
cacheoptional |
boolean |
Enable content-hash based caching. Skips rendering when content hasn't changed. Default true |
concurrencyoptional |
number |
Number of concurrent page instances for parallel rendering. Default 1 |
heightoptional |
number |
Image height in pixels. Default 630 |
rendereroptional |
OgImageRenderer |
Rendering backend. - "chromium": full browser rendering, best template compatibility- "satori": fast HTML-to-SVG-to-PNG rendering, limited CSS subsetDefault "chromium" |
satorioptional |
OgImageSatoriOptions |
Options for the Satori renderer. |
templateoptional |
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 SSRIf not specified, the built-in default template is used. |
vuePluginoptional |
"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' |
widthoptional |
number |
Image width in pixels. Default 1200 |
OgImageRenderer = "chromium" | "satori"OG image rendering backend.OG image rendering backend.
export type OgImageRenderer = "chromium" | "satori"OgImageSatoriFontFont file loaded by the Satori renderer.Font file loaded by the Satori renderer.
export interface OgImageSatoriFont| Name | Type | Description |
|---|---|---|
nameoptional |
string |
Font family name used by template CSS. |
path |
string |
Absolute path, or a path relative to the project root. |
styleoptional |
"normal" | "italic" |
Font style. Default "normal" |
weightoptional |
OgImageSatoriFontWeight |
Font weight. Default 400 |
OgImageSatoriFontWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900Font weight values supported by Satori.Font weight values supported by Satori.
export type OgImageSatoriFontWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900OgImageSatoriOptionsSatori renderer options.Satori renderer options.
export interface OgImageSatoriOptions| Name | Type | Description |
|---|---|---|
fontsoptional |
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. |
systemFontFallbackoptional |
boolean |
Try known OS font paths when fonts is empty.Default true |
OpenApiDocsInputOne local OpenAPI file consumed by generated REST API docs.One local OpenAPI file consumed by generated REST API docs.
export interface OpenApiDocsInput| Name | Type | Description |
|---|---|---|
failOnUnresolvedRefsoptional |
boolean |
Fail on unresolved or remote $ref values. Defaults to true. |
nameoptional |
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. |
OpenApiDocsOptionsObject form for configuring generated OpenAPI docs.Object form for configuring generated OpenAPI docs.
export interface OpenApiDocsOptions| Name | Type | Description |
|---|---|---|
basePathoptional |
string |
Route prefix used by generated OpenAPI nav metadata. Defaults to basePath or /api. |
failOnUnresolvedRefsoptional |
boolean |
Default unresolved $ref policy for sources. Defaults to true. |
srcoptional |
OpenApiDocsSource | OpenApiDocsSource[] |
Local OpenAPI files to render. |
OpenApiDocsSource = string | OpenApiDocsInputOpenAPI docs shorthand accepted by docs.openapi.OpenAPI docs shorthand accepted by docs.openapi.
export type OpenApiDocsSource = string | OpenApiDocsInputOxContentOptionsOptions for the core oxContent() Vite plugin. The top-level options describe wh…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.export interface OxContentOptions| Name | Type | Description |
|---|---|---|
abbreviationsoptional |
boolean | AbbreviationsOptions |
Opt-in abbreviation and glossary expansion. Passing true or an options object expands *[LSP]: Language Server Protocoland config terms into <abbr class="ox-abbr">. Matching uses Unicode wordboundaries. Fenced, indented, inline, and raw code, HTML comments, and existing links are skipped. There is no client JavaScript. Default false |
attrsoptional |
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 |
autolinksoptional |
boolean |
Enable GFM autolinks and linkify bare URLs. Default true |
autolinkTargetBlankoptional |
boolean |
Add target="_blank" rel="noopener noreferrer" to linkified bare URLs.Default true |
badgesoptional |
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 |
baseoptional |
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 '/' |
blogoptional |
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 |
budouxoptional |
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 |
cardsoptional |
boolean | CardOptions |
Opt-in ::: card / ::: link-card / ::: card-grid blocks.Passing true enables the defaults. Pass an object to keep the optionshape while overriding enabled.Default false |
cascadeoptional |
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 |
citationsoptional |
boolean | CitationsOptions |
Opt-in bibliography-backed citation references. References such as [@rfc9110] and [@smith2024; @doe2023] becomelinks to generated bibliography entries loaded from local CSL JSON files. Default false |
cjkEmphasisoptional |
boolean |
Recognize emphasis adjacent to CJK text. The native parser already supports this behavior; the option documents the compatibility contract. Default false |
codeAnnotationsoptional |
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 tochange the meta key or enable VitePress-compatible notation. Default false |
codeBlockLintoptional |
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 |
codeBlockTypecheckoptional |
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 |
codeGroupsoptional |
boolean | CodeGroupOptions |
Opt-in VitePress-style ::: code-group fence groups.Passing true or {} enables rewriting labeled fences into theexisting no-JS tab widget. Omitted or false leaves the source onthe normal Markdown/container path. Default false |
codeImportsoptional |
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 adirectory other than the Vite project root. Default false |
collectionsoptional |
CollectionsOptions | boolean |
Markdown collection query options. Collections are exposed through virtual:ox-content/collections. Thedefault collection is metadata-only and is built by the native Rust manifest builder without rendering every document; add include fieldsonly for routes that need raw or rendered content in the query payload. Default content collection for all Markdown files |
conditionalBlocksoptional |
boolean | ConditionalBlockOptions |
Opt-in static ::: if / ::: else blocks.Conditions are evaluated from conditionalBlocks.values and pagefrontmatter 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 |
containersoptional |
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 extratypes or override titles. Default false |
crossReferencesoptional |
boolean | CrossReferencesOptions |
Opt-in labeled cross-references for headings, figures/images, and tables. References such as @sec-install, @fig-pipeline, and @tbl-optionsbecome links to matching id attributes generated by attrs or nativeMarkdown rendering. Missing labels, duplicate labels, and prefix/type mismatches fail by default and can be downgraded to warnings. Default false |
dataTablesoptional |
boolean | DataTableOptions |
Opt-in static tables from csv-table / json-table fences.Passing true or {} enables the transform. Inline CSV/JSON becomes asemantic <table> with a responsive wrapper. src or a single path bodycan import @/data/options.csv or ./options.json. Paths cannot escapethe content/project root with ... Missing imports use missing.Default false |
definitionListsoptional |
boolean | DefinitionListOptions |
Opt-in PHP Markdown Extra / mdBook-style definition lists. Passing true or an options object turnsTerm / : 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 |
docsoptional |
DocsOptions | false |
Source documentation generation options. Set to false to disable (opt-out). Default { enabled: true } |
docsTestsoptional |
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 |
editThisPageoptional |
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 enoughrepository information to generate valid links. Default false |
embedsoptional |
BuiltinEmbedOptions | false |
Built-in static embeds rendered during Markdown transformation. Set to false to disable all built-in embeds.Default { github: true, openGraph: true } |
emojiShortcodesoptional |
boolean | EmojiShortcodeOptions |
Expand :shortcode: emoji aliases to Unicode.Built-in aliases cover common emoji names. Provide custom entries forproject-specific aliases or to override a built-in mapping. Default false |
extensionsoptional |
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'] |
feedsoptional |
boolean | FeedsOptions |
Write RSS, Atom, and/or JSON Feed files from a named collection. Off by default. true writes all three formats from the contentcollection (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 awarning is emitted instead of writing files. Default false |
fileTreeoptional |
boolean | FileTreeOptions |
Opt-in static directory trees from file-tree fences.Passing true or {} enables the transform. Names are escaped and neverread 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 |
footnotesoptional |
boolean |
Enable footnotes. Default true |
frontmatteroptional |
boolean |
Parse YAML frontmatter. Default true |
gfmoptional |
boolean |
Enable GitHub Flavored Markdown extensions. Default true |
graphvizoptional |
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 |
headingAttributesoptional |
boolean |
Enable Pandoc-style heading attribute blocks. A trailing {#id .class} block on a heading becomes the renderedheading's id/classes and is excluded from visible heading text and slug generation. Default false |
headingPermalinksoptional |
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 |
highlightoptional |
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-* customproperties so theme-color packages resolve highlighting. Languages with no native grammar stay unhighlighted. Default false |
i18noptional |
I18nOptions | false |
i18n (internationalization) options. Set to false to disable i18n. Default false |
iconsoptional |
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 buildcan resolve collections without a network request. Default false |
imageGalleriesoptional |
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 |
imagesoptional |
boolean | ImageOptions |
Opt-in figures, captions, and lazy-loaded images. Title text becomes a <figcaption>. Optional {width=N height=M} on theimage is consumed by this feature and does not require attrs. Passingtrue or {} enables defaults (lazy: true).Default false |
includesoptional |
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 outsiderootDir are rejected and reported as transform errors.Default false |
keyboardKeysoptional |
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 |
linkTargetBlankoptional |
boolean |
Add target="_blank" rel="noopener noreferrer" to parsed http(s) Markdown links.Default true |
magicLinksoptional |
boolean | MagicLinkOptions |
Opt-in {link:...} rich magic links.Passing true or an options object enables GitHub-user, alias, andexplicit 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 |
mathoptional |
boolean | MathOptions |
Enable $…$ inline and $$…$$ block math.Currency-like $ runs, fenced code, indented code, and inline code stayliteral. TeX is HTML-escaped into accessible MathML mtext.Default false |
mdxoptional |
boolean |
Enable MDX JSX, ESM, and expressions. When omitted, MDX is enabled for .mdx files only. Set true to enableit for every configured extension or false to keep .mdx on the plainMarkdown path. Default inferred from the source extension |
mermaidoptional |
boolean |
Enable mermaid diagram rendering. Default false |
notByAioptional |
boolean | NotByAiOptions |
Opt-in <NotByAI /> authorship disclosure badge.Passing true or an options object emits the official Not By AI light/darkartwork as static HTML. This is not a status badge — see badges for{badge:tip} labels. Disabled when omitted. Fenced, indented, and inlinecode plus HTML comments are skipped. Default false |
ogImageoptional |
boolean |
Enable OG image generation. Default false |
ogImageOptionsoptional |
OgImageOptions |
OG image generation options. Ignored unless ogImage or ssg.generateOgImage is enabled.Default { vuePlugin: 'vitejs', width: 1200, height: 630, cache: true, concurrency: 1 } |
ogVieweroptional |
boolean |
Enable OG Viewer dev tool. Accessible at /__og-viewer during development. Default true |
outDiroptional |
string |
Directory where generated files are written. SSG HTML, search indexes, and generated assets are emitted under this directory during production builds. Default 'dist' |
partialsoptional |
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 |
permalinksoptional |
boolean | PermalinksOptions |
Honor frontmatter permalink / slug when resolving page URLs.Off by default. true or {} replaces the file-tree URL withpermalink, 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 thatresolve to the same URL produce an error; the first page is kept and the later page is skipped. Default false |
publishStateoptional |
boolean | PublishStateOptions |
Honor frontmatter draft / unlisted / scheduled publish states. Off by default. true omits drafts and future-scheduled pages fromproduction 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 |
pwaoptional |
boolean | PwaOptions |
Write a web app manifest and an optional service worker. Off by default. true writes manifest.webmanifest and sw.js, andinjects a tiny client script that registers the worker on themed pages. An object enables the feature and can set offline: false to keep themanifest without caching or that script. This adds client JavaScript when offline is on. Requires ssg.siteUrl. When that is missing thebuild continues and a warning is emitted instead of writing files. Default false |
redirectsoptional |
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. Destinationsmust 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 |
resourcesoptional |
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 buildwhen 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 |
sanitizeoptional |
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 |
searchoptional |
SearchOptions | boolean |
Full-text search options. Set to false to disable search. Default { enabled: true } |
semanticFootnotesoptional |
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 |
siteMapsoptional |
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 awarning is emitted instead of writing files. Default false |
smartPunctuationoptional |
boolean |
Enable smart punctuation replacement. Default false |
sourceSpansoptional |
boolean |
Emit data-source-span="start-end" on rendered block elements.Default false |
srcDiroptional |
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' |
ssgoptional |
SsgOptions | boolean |
Static Site Generation options. Passing true or omitting this option enables SSG with defaults. Passingfalse disables the SSG plugin while still allowing Markdown moduletransforms to run. Default { enabled: true } |
stepsoptional |
boolean | StepsOptions |
Restyle a ::: steps wrapper around an ordered list.Disabled when omitted or false. true and {} enable the defaultstep-list markup. Ordinary ordered lists outside ::: steps are unchanged.Default false |
strikethroughoptional |
boolean |
Enable strikethrough. Default true |
subscriptoptional |
boolean |
Enable ~text~ subscript spans.Default false |
superscriptoptional |
boolean |
Enable ^text^ superscript spans.Default false |
tablesoptional |
boolean |
Enable tables. Default true |
taskListsoptional |
boolean |
Enable task lists. Default true |
taxonomiesoptional |
boolean | TaxonomiesOptions |
Write tag/category term pages and inject related-page lists. Off by default. true reads frontmatter tags and categories andwrites 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 isHTML-escaped. Default false |
timelinesoptional |
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 hrefmetadata while nested Markdown stays searchable and static. Default false |
tocoptional |
boolean |
Generate table of contents. Default true |
tocMaxDepthoptional |
number |
Maximum heading depth for TOC. Default 3 |
transformersoptional |
MarkdownTransformer[] |
Custom AST transformers. Transformers run after parsing and before the final JavaScript module is emitted. Default [] |
typedHoveroptional |
boolean | TypedHoverOptions |
Attach build-time TypeScript hover overlays to opted-in fences. Off by default. true or {} enables the feature. Only ts / tsxfences tagged twoslash receive payloads. Types are generated duringthe Markdown transform; no TypeScript compiler is shipped to the browser. Default false |
versionsoptional |
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 objectenables the feature and lists additional versions. Historical snapshot directories are read, never rewritten. Default false |
wikiLinksoptional |
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 |
xrefsoptional |
boolean | CrossReferencesOptions |
Alias for crossReferences.Default false |
ParamDocParameter documentation.Parameter documentation.
export interface ParamDoc| Name | Type | Description |
|---|---|---|
defaultoptional |
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. |
optionaloptional |
boolean |
True when the parameter is optional. |
type |
string |
Rendered TypeScript type text. |
PartialsOptionsOptions for parameterized Markdown partials with <!-- @partial: PATH k="v" -->.…Options for parameterized Markdown partials with <!-- @partial: PATH k="v" -->.
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.
export interface PartialsOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable the transform when an options object is supplied. Default true |
missingoptional |
"literal" | "error" |
Missing {{ name }} substitutions stay literal, or report a diagnostic.Default "literal" |
rootoptional |
string |
Directory used for bare names such as install.md.Default "_partials" |
rootDiroptional |
string |
Directory used to resolve @/ and absolute partial paths.Default undefined |
PermalinksOptionsOpt-in frontmatter permalink / slug routing. false or omitted stays off. true o…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.
export interface PermalinksOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable permalink / slug routing. Default true |
PublishStateOptionsOpt-in draft / unlisted / scheduled page filtering.Opt-in draft / unlisted / scheduled page filtering.
export interface PublishStateOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
When false, frontmatter publish fields are ignored.Default true when the option is an object |
includeDraftsoptional |
boolean |
Keep draft and not-yet-scheduled pages in output. The dev server sets this. Default false |
nowoptional |
string |
Injected ISO-8601 clock compared against scheduled, date, and expiry.Invalid values fall back to the system clock. |
PwaOptionsOpt-in web app manifest and service worker written during SSG. Enabling offline…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.
export interface PwaOptions| Name | Type | Description |
|---|---|---|
backgroundColoroptional |
string |
Manifest background color. Hex or a CSS color name. Default "#ffffff" |
nameoptional |
string |
Manifest name. Falls back to ssg.siteName when omitted. |
offlineoptional |
boolean |
Write sw.js and register it from themed pages.Default true |
shortNameoptional |
string |
Manifest short_name. Falls back to name when omitted. |
startUrloptional |
string |
Manifest start_url. Same-origin site paths only (/, /docs/).Defaults to the Vite base. |
themeColoroptional |
string |
Manifest / meta theme color. Hex ( #rgb / #rrggbb) or a CSS color name.Default "#000000" |
RedirectProvider = "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.
export type RedirectProvider = "netlify" | "cloudflare"RedirectsOptionsOpt-in static redirects, aliases, and path rewrites. A path map such as { "/old…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.
export interface RedirectsOptions| Name | Type | Description |
|---|---|---|
allowExternaloptional |
boolean |
Allow http:// and https:// destinations. javascript:, data:, andprotocol-relative // targets stay rejected.Default false |
headersoptional |
boolean |
Write a _headers Location map next to the HTML pages.Default false |
htmloptional |
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 |
jsonoptional |
boolean |
Write a machine-readable redirects.json map.Default false |
mapoptional |
Record<string, string> |
Old path to new path. Destinations must be same-origin ( / but not //)unless allowExternal is set.Default {} |
provideroptional |
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. |
ResolvedA11y = 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.
export type ResolvedA11y = false | { skipLinkLabel: string }ResolvedAbbreviationsOptionsResolved abbreviation / glossary transform options.Resolved abbreviation / glossary transform options.
export interface ResolvedAbbreviationsOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
firstUseOnly |
boolean |
|
terms |
Record<string, string> |
ResolvedAttrsOptionsResolved attrs transform options.Resolved attrs transform options.
export interface ResolvedAttrsOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
ResolvedBadgeOptionsResolved inline-badge transform options.Resolved inline-badge transform options.
export interface ResolvedBadgeOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
ResolvedBlogFeedSourceResolved external blog feed source.Resolved external blog feed source.
export interface ResolvedBlogFeedSource| Name | Type | Description |
|---|---|---|
authoroptional |
string |
|
languageoptional |
string |
|
onError |
BlogFeedFailurePolicy |
|
url |
string |
ResolvedBlogOptionsResolved blog options.Resolved blog options.
export interface ResolvedBlogOptions| Name | Type | Description |
|---|---|---|
authors |
Record<string, BlogAuthor> |
|
collectionoptional |
string |
|
enabled |
boolean |
|
feeds |
ResolvedBlogFeedSource[] |
|
pageSize |
number |
ResolvedBuiltinEmbedOptionsResolved built-in embed configuration.Resolved built-in embed configuration.
export interface ResolvedBuiltinEmbedOptions| Name | Type | Description |
|---|---|---|
appleMusic |
boolean |
|
asciinemaoptional |
boolean |
|
audiooptional |
boolean |
|
bluesky |
boolean |
|
discordoptional |
boolean |
|
facebookoptional |
boolean |
|
fediverseoptional |
boolean |
|
figmaoptional |
boolean |
|
github |
GitHubOptions | false |
|
googleMapsoptional |
boolean |
|
googleSlidesoptional |
boolean |
|
instagramoptional |
boolean |
|
loomoptional |
boolean |
|
noteoptional |
boolean |
|
openGraph |
OgpOptions | false |
|
packageRegistryoptional |
ProviderPackageEmbedOptions | false |
|
playgroundsoptional |
ProviderPlaygroundEmbedOptions | false |
|
pm |
BuiltinPmOptions | false |
|
qiitaoptional |
ProviderArticleEmbedOptions | false |
|
redditoptional |
RedditEmbedOptions | false |
|
speakerDeck |
boolean |
|
spotify |
boolean |
|
stackBlitz |
boolean |
|
threadsoptional |
boolean |
|
twitchoptional |
ProviderVideoEmbedOptions | false |
|
twitter |
TwitterEmbedOptions | false |
|
videooptional |
boolean |
|
vimeooptional |
ProviderVideoEmbedOptions | false |
|
webContainer |
boolean |
|
zennoptional |
ProviderArticleEmbedOptions | false |
ResolvedCardOptionsResolved card transform options.Resolved card transform options.
export interface ResolvedCardOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
ResolvedCascadeOptionsResolved cascade options.Resolved cascade options.
export interface ResolvedCascadeOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
ResolvedCodeAnnotationsOptionsResolved code annotation configuration.Resolved code annotation configuration.
export interface ResolvedCodeAnnotationsOptions| Name | Type | Description |
|---|---|---|
defaultLineNumbers |
boolean |
|
enabled |
boolean |
|
metaKey |
string |
|
notation |
CodeAnnotationSyntax |
ResolvedCodeBlockLintOptionsResolved code-block lint options.Resolved code-block lint options.
export interface ResolvedCodeBlockLintOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
languagesoptional |
string[] |
|
mode |
"warn" | "error" |
|
requireLanguage |
boolean |
|
trailingSpaces |
boolean |
ResolvedCodeBlockTypecheckOptionsResolved code-block type-check options.Resolved code-block type-check options.
export interface ResolvedCodeBlockTypecheckOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
languages |
string[] |
|
mode |
"warn" | "error" |
|
requireMeta |
boolean |
|
tsgoCommand |
string |
ResolvedCodeGroupOptionsResolved code-group transform options.Resolved code-group transform options.
export interface ResolvedCodeGroupOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
ResolvedCodeImportOptionsResolved code-import transform options.Resolved code-import transform options.
export interface ResolvedCodeImportOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
rootDiroptional |
string |
ResolvedCollectionOptionsResolved collection definition.Resolved collection definition.
export interface ResolvedCollectionOptions| Name | Type | Description |
|---|---|---|
include |
CollectionIncludeField[] |
|
name |
string |
|
source |
string[] |
|
validateoptional |
CollectionValidateHook |
|
ResolvedCollectionsOptionsResolved collection options.Resolved collection options.
export interface ResolvedCollectionsOptions| Name | Type | Description |
|---|---|---|
collections |
Record<string, ResolvedCollectionOptions> |
|
enabled |
boolean |
ResolvedConditionalBlockOptionsResolved conditional-block transform options.Resolved conditional-block transform options.
export interface ResolvedConditionalBlockOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
values |
Record<string, unknown> |
ResolvedContainerOptionsResolved custom-container transform options.Resolved custom-container transform options.
export interface ResolvedContainerOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
types |
Record<string, ContainerTypeOptions> |
ResolvedContributors = 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.
export type ResolvedContributors = false | { ignore: string[]; avatars: boolean }ResolvedDataTableOptionsResolved data-table transform options.Resolved data-table transform options.
export interface ResolvedDataTableOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
missing |
"error" | "warn" |
|
rootDiroptional |
string |
ResolvedDefinitionListOptionsResolved definition-list transform options.Resolved definition-list transform options.
export interface ResolvedDefinitionListOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
ResolvedDocsEntryPointResolved public API entry point.Resolved public API entry point.
export interface ResolvedDocsEntryPoint| Name | Type | Description |
|---|---|---|
nameoptional |
string |
|
path |
string |
ResolvedDocsOptionsResolved docs options with all defaults applied.Resolved docs options with all defaults applied.
export interface ResolvedDocsOptions| Name | Type | Description |
|---|---|---|
basePathoptional |
string |
|
classPropertiesFormat |
MarkdownDisplayFormat |
|
enabled |
boolean |
|
entryPointsoptional |
ResolvedDocsEntryPoint[] |
|
enumMembersFormat |
MarkdownDisplayFormat |
|
exclude |
string[] |
|
format |
"markdown" | "json" | "html" |
|
generateNav |
boolean |
|
githubUrloptional |
string |
|
groupBy |
"file" | "category" |
|
groupOrderoptional |
string[] |
|
include |
string[] |
|
indexFormat |
MarkdownDisplayFormat |
|
interfacePropertiesFormat |
MarkdownDisplayFormat |
|
internal |
boolean |
|
kindSortOrderoptional |
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" |
|
sortoptional |
DocsSortStrategy[] |
|
sortEntryPoints |
boolean |
|
src |
string[] |
|
toc |
boolean |
|
typeAliasPropertiesFormat |
MarkdownDisplayFormat |
|
typeDeclarationFormat |
MarkdownDisplayFormat |
|
typeParameters |
boolean |
ResolvedDocsTestOptionsResolved docs-as-tests extraction options.Resolved docs-as-tests extraction options.
export interface ResolvedDocsTestOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
languages |
string[] |
|
requireMeta |
boolean |
ResolvedEditThisPageOptionsResolved edit-link transform options.Resolved edit-link transform options.
export interface ResolvedEditThisPageOptions| Name | Type | Description |
|---|---|---|
branch |
string |
|
enabled |
boolean |
|
label |
string |
|
provideroptional |
EditThisPageProvider |
|
repoUrloptional |
string |
|
rootDiroptional |
string |
|
urlPatternoptional |
string |
ResolvedEmojiShortcodeOptionsResolved emoji-shortcode transform options.Resolved emoji-shortcode transform options.
export interface ResolvedEmojiShortcodeOptions| Name | Type | Description |
|---|---|---|
custom |
Record<string, string> |
|
enabled |
boolean |
ResolvedFeedChannelOne resolved feed channel.One resolved feed channel.
export interface ResolvedFeedChannel| Name | Type | Description |
|---|---|---|
collectionoptional |
string |
|
copyrightoptional |
string |
|
descriptionoptional |
string |
|
faviconoptional |
string |
|
formats |
readonly FeedFormat[] |
|
imageoptional |
string |
|
itemsoptional |
FeedItemsSource |
|
languageoptional |
string |
|
limit |
number |
|
nameoptional |
string |
|
path |
string |
|
titleoptional |
string |
ResolvedFeedsOptions extends ResolvedFeedChannelResolved feed options. Legacy true / single-object configs keep one channel on…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.
export interface ResolvedFeedsOptions extends ResolvedFeedChannel| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
feedsoptional |
ResolvedFeedChannel[] |
ResolvedFileTreeOptionsResolved file-tree transform options.Resolved file-tree transform options.
export interface ResolvedFileTreeOptions| Name | Type | Description |
|---|---|---|
defaultOpen |
boolean |
|
enabled |
boolean |
|
iconFileoptional |
string |
|
iconFilesoptional |
Record<string, string> |
|
iconFolderoptional |
string |
|
iconFolderOpenoptional |
string |
|
icons |
boolean |
ResolvedHeadingPermalinksOptionsResolved heading permalink options.Resolved heading permalink options.
export interface ResolvedHeadingPermalinksOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
ResolvedI18nOptionsResolved i18n options with all defaults applied.Resolved i18n options with all defaults applied.
export interface ResolvedI18nOptions| Name | Type | Description |
|---|---|---|
check |
boolean |
|
defaultLocale |
string |
|
dir |
string |
|
enabled |
boolean |
|
functionNames |
string[] |
|
hideDefaultLocale |
boolean |
|
locales |
LocaleConfig[] |
ResolvedIconsOptionsResolved icon asset options.Resolved icon asset options.
export interface ResolvedIconsOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
include |
string[] |
|
mode |
"css-mask" |
|
safelist |
string[] |
|
syntax |
"unocss" |
ResolvedImageGalleryOptionsResolved image gallery transform options.Resolved image gallery transform options.
export interface ResolvedImageGalleryOptions| Name | Type | Description |
|---|---|---|
empty |
"error" | "warn" | "ignore" |
|
enabled |
boolean |
|
lazyoptional |
boolean |
|
missingAlt |
"error" | "warn" | "ignore" |
ResolvedImageOptionsResolved image transform options.Resolved image transform options.
export interface ResolvedImageOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
lazy |
boolean |
ResolvedIncludeOptionsResolved Markdown-include transform options.Resolved Markdown-include transform options.
export interface ResolvedIncludeOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
rootDiroptional |
string |
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">.
export type ResolvedJsonLd = false | { breadcrumbs: boolean; publisher?: { name?: string; url?: string }; type?: JsonLdPageType; graph?: Record<string, unknown>[] }ResolvedKeyboardKeysOptionsResolved inline keyboard-key transform options.Resolved inline keyboard-key transform options.
export interface ResolvedKeyboardKeysOptions| Name | Type | Description |
|---|---|---|
aliases |
Record<string, string> |
|
enabled |
boolean |
|
style |
"words" | "symbols" |
ResolvedMagicLinkOptionsResolved magic-link transform options.Resolved magic-link transform options.
export interface ResolvedMagicLinkOptions| Name | Type | Description |
|---|---|---|
aliases |
Record<string, MagicLinkAlias> |
|
enabled |
boolean |
|
favicon |
boolean |
|
faviconTemplateoptional |
string |
|
imageOverrides |
MagicLinkImageOverride[] |
ResolvedMarkdownSourceOptionsResolved Markdown source-companion options.Resolved Markdown source-companion options.
export interface ResolvedMarkdownSourceOptions| Name | Type | Description |
|---|---|---|
alternate |
boolean |
|
copy |
boolean |
|
enabled |
boolean |
ResolvedMathOptionsResolved math transform options.Resolved math transform options.
export interface ResolvedMathOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
fontFormats |
KatexFontFormats |
|
onError |
MathErrorPolicy |
ResolvedNotByAiOptionsResolved NotByAI authorship-badge options.Resolved NotByAI authorship-badge options.
export interface ResolvedNotByAiOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
href |
string |
|
label |
string |
ResolvedNotFoundOptionsResolved custom 404 options.Resolved custom 404 options.
export interface ResolvedNotFoundOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
output |
string |
|
source |
string |
ResolvedOgImageOptionsResolved OG image options with all defaults applied.Resolved OG image options with all defaults applied.
export interface ResolvedOgImageOptions| Name | Type | Description |
|---|---|---|
cache |
boolean |
|
concurrency |
number |
|
height |
number |
|
renderer |
OgImageRenderer |
|
satori |
{ fonts: OgImageSatoriFont[]; systemFontFallback: boolean } |
|
templateoptional |
string |
|
vuePlugin |
"vitejs" | "vizejs" |
|
width |
number |
ResolvedOpenApiDocsInputResolved local OpenAPI file input.Resolved local OpenAPI file input.
export interface ResolvedOpenApiDocsInput| Name | Type | Description |
|---|---|---|
failOnUnresolvedRefs |
boolean |
|
nameoptional |
string |
|
path |
string |
ResolvedOpenApiDocsOptionsResolved generated OpenAPI docs options.Resolved generated OpenAPI docs options.
export interface ResolvedOpenApiDocsOptions| Name | Type | Description |
|---|---|---|
basePathoptional |
string |
|
src |
ResolvedOpenApiDocsInput[] |
ResolvedOptionsResolved options with all defaults applied.Resolved options with all defaults applied.
export interface ResolvedOptions| Name | Type | Description |
|---|---|---|
abbreviationsoptional |
ResolvedAbbreviationsOptions |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
attrs |
ResolvedAttrsOptions |
|
autolinks |
boolean |
|
autolinkTargetBlankoptional |
boolean |
|
badges |
ResolvedBadgeOptions |
|
base |
string |
|
blogoptional |
ResolvedBlogOptions |
|
budouxoptional |
ResolvedBudouxOptions |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
cards |
ResolvedCardOptions |
|
cascadeoptional |
ResolvedCascadeOptions |
|
citations |
ResolvedCitationsOptions |
|
cjkEmphasis |
boolean |
|
codeAnnotations |
ResolvedCodeAnnotationsOptions |
|
codeBlockLint |
ResolvedCodeBlockLintOptions |
|
codeBlockTypecheck |
ResolvedCodeBlockTypecheckOptions |
|
codeGroupsoptional |
ResolvedCodeGroupOptions |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
codeImports |
ResolvedCodeImportOptions |
|
collections |
ResolvedCollectionsOptions |
|
conditionalBlocksoptional |
ResolvedConditionalBlockOptions |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
containers |
ResolvedContainerOptions |
|
crossReferences |
ResolvedCrossReferencesOptions |
|
dataTables |
ResolvedDataTableOptions |
|
definitionListsoptional |
ResolvedDefinitionListOptions |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
docs |
ResolvedDocsOptions | false |
|
docsTests |
ResolvedDocsTestOptions |
|
editThisPage |
ResolvedEditThisPageOptions |
|
embeds |
ResolvedBuiltinEmbedOptions |
|
emojiShortcodes |
ResolvedEmojiShortcodeOptions |
|
extensions |
string[] |
|
feedsoptional |
ResolvedFeedsOptions |
|
fileTree |
ResolvedFileTreeOptions |
|
footnotes |
boolean |
|
frontmatter |
boolean |
|
gfm |
boolean |
|
graphviz |
ResolvedGraphvizOptions | false |
|
headingAttributes |
boolean |
|
headingPermalinksoptional |
ResolvedHeadingPermalinksOptions |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
highlight |
boolean |
|
i18n |
ResolvedI18nOptions | false |
|
iconsoptional |
ResolvedIconsOptions |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
imageGalleriesoptional |
ResolvedImageGalleryOptions |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
images |
ResolvedImageOptions |
|
includes |
ResolvedIncludeOptions |
|
keyboardKeysoptional |
ResolvedKeyboardKeysOptions |
|
linkTargetBlankoptional |
boolean |
|
magicLinksoptional |
ResolvedMagicLinkOptions |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
math |
ResolvedMathOptions |
|
mdxoptional |
boolean |
|
mermaid |
boolean |
|
notByAioptional |
ResolvedNotByAiOptions |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
ogImage |
boolean |
|
ogImageOptions |
ResolvedOgImageOptions |
|
ogViewer |
boolean |
|
outDir |
string |
|
partialsoptional |
ResolvedPartialsOptions |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
permalinksoptional |
ResolvedPermalinksOptions |
|
publishStateoptional |
ResolvedPublishStateOptions |
|
pwaoptional |
ResolvedPwaOptions |
|
redirectsoptional |
ResolvedRedirectsOptions |
|
resourcesoptional |
ResolvedResourcesOptions |
|
sanitize |
ResolvedSanitizeOptions |
|
search |
ResolvedSearchOptions |
|
semanticFootnotesoptional |
boolean |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
siteMapsoptional |
ResolvedSiteMapsOptions |
|
smartPunctuation |
boolean |
|
sourceSpansoptional |
boolean |
|
srcDir |
string |
|
ssg |
ResolvedSsgOptions |
|
steps |
ResolvedStepsOptions |
|
strikethrough |
boolean |
|
subscript |
boolean |
|
superscript |
boolean |
|
tables |
boolean |
|
taskLists |
boolean |
|
taxonomiesoptional |
ResolvedTaxonomiesOptions |
|
timelinesoptional |
ResolvedTimelineOptions |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
toc |
boolean |
|
tocMaxDepth |
number |
|
transformers |
MarkdownTransformer[] |
|
typedHoveroptional |
ResolvedTypedHoverOptions |
Present after resolveOptions. Omitted in hand-built fixtures means off. |
versionsoptional |
ResolvedVersionsOptions |
|
wikiLinks |
ResolvedWikiLinkOptions |
ResolvedPartialsOptionsResolved parameterized-partial transform options.Resolved parameterized-partial transform options.
export interface ResolvedPartialsOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
missing |
"literal" | "error" |
|
root |
string |
|
rootDiroptional |
string |
ResolvedPermalinksOptionsResolved permalink options.Resolved permalink options.
export interface ResolvedPermalinksOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
ResolvedPublishStateOptionsResolved publish-state options.Resolved publish-state options.
export interface ResolvedPublishStateOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
includeDrafts |
boolean |
|
nowoptional |
string |
ResolvedPwaOptionsResolved PWA options.Resolved PWA options.
export interface ResolvedPwaOptions| Name | Type | Description |
|---|---|---|
backgroundColoroptional |
string |
|
enabled |
boolean |
|
nameoptional |
string |
|
offline |
boolean |
|
shortNameoptional |
string |
|
startUrloptional |
string |
|
themeColoroptional |
string |
ResolvedRedirectsOptionsResolved redirect options.Resolved redirect options.
export interface ResolvedRedirectsOptions| Name | Type | Description |
|---|---|---|
allowExternal |
boolean |
|
enabled |
boolean |
|
headers |
boolean |
|
html |
boolean |
|
json |
boolean |
|
map |
Record<string, string> |
|
provideroptional |
RedirectProvider |
ResolvedResourcesOptionsResolved page-resource options.Resolved page-resource options.
export interface ResolvedResourcesOptions| Name | Type | Description |
|---|---|---|
dedupe |
boolean |
|
enabled |
boolean |
|
formats |
string[] |
|
missing |
"error" | "warn" |
|
widths |
number[] |
ResolvedSanitizeOptionsResolved sanitize transform options.Resolved sanitize transform options.
export interface ResolvedSanitizeOptions| Name | Type | Description |
|---|---|---|
allowedAttributesoptional |
string[] |
|
allowedTagsoptional |
string[] |
|
allowedUrlSchemesoptional |
string[] |
|
enabled |
boolean |
ResolvedSearchOptionsResolved search options.Resolved search options.
export interface ResolvedSearchOptions| Name | Type | Description |
|---|---|---|
appIdoptional |
string |
|
enabled |
boolean |
|
endpointoptional |
string |
|
fuzzy |
boolean |
|
hotkey |
string |
|
indexNameoptional |
string |
|
limit |
number |
|
placeholder |
string |
|
prefix |
boolean |
|
provideroptional |
"local" | "hosted" |
|
publicKeyoptional |
string |
|
searchKeyoptional |
string |
ResolvedSectionIndexOptionsResolved generated section index options.Resolved generated section index options.
export interface ResolvedSectionIndexOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
style |
SectionIndexStyle |
ResolvedSiteMapsOptionsResolved crawl-manifest options.Resolved crawl-manifest options.
export interface ResolvedSiteMapsOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
llms |
boolean |
|
robots |
boolean |
ResolvedSsgOptionsResolved SSG options.Resolved SSG options.
export interface ResolvedSsgOptions| Name | Type | Description |
|---|---|---|
a11y |
ResolvedA11y |
|
bare |
boolean |
|
blogoptional |
ResolvedBlogOptions |
Present after resolveSsgOptions. Omitted in hand-built fixtures means off. |
bodyEndoptional |
string |
|
bodyStartoptional |
string |
|
breadcrumbs |
boolean |
|
clean |
boolean |
|
contributorsoptional |
ResolvedContributors |
Present after resolveSsgOptions. Omitted in hand-built fixtures means off. |
enabled |
boolean |
|
extension |
string |
|
generateOgImage |
boolean |
|
headoptional |
string |
|
headValidationoptional |
false | "warn" | "strict" |
Present after resolveSsgOptions. Omitted / false means off. |
jsonLd |
ResolvedJsonLd |
|
langoptional |
string |
|
lastUpdated |
boolean |
|
localeSwitcher |
boolean |
|
markdownSourceoptional |
ResolvedMarkdownSourceOptions |
Present after resolveSsgOptions. Omitted in hand-built fixtures means off. |
minifyHtml |
boolean |
|
navigationoptional |
SsgNavigationGroup[] |
|
notFoundoptional |
ResolvedNotFoundOptions |
Present after resolveSsgOptions. Omitted in hand-built fixtures means off. |
ogImageoptional |
string |
|
pageChrome |
boolean |
|
pagination |
boolean |
|
readerChrome |
ResolvedReaderChrome |
|
renderoptional |
ThemeComponent |
|
routePrefixoptional |
string |
Present after resolveSsgOptions. Omitted / empty means off. |
sectionIndexoptional |
ResolvedSectionIndexOptions |
|
siteNameoptional |
string |
|
siteUrloptional |
string |
|
teamoptional |
ResolvedTeamOptions |
Present after resolveSsgOptions. Omitted in hand-built fixtures means off. |
themeoptional |
ResolvedThemeConfig |
|
transformConcurrencyoptional |
number |
ResolvedStepsOptionsResolved step-list transform options.Resolved step-list transform options.
export interface ResolvedStepsOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
ResolvedTaxonomiesOptionsResolved taxonomy options.Resolved taxonomy options.
export interface ResolvedTaxonomiesOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
relatedLimit |
number |
|
taxonomies |
string[] |
ResolvedTeamOptionsResolved team page options.Resolved team page options.
export interface ResolvedTeamOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
members |
TeamMember[] |
ResolvedTimelineOptionsResolved timeline transform options.Resolved timeline transform options.
export interface ResolvedTimelineOptions| Name | Type | Description |
|---|---|---|
empty |
"error" | "warn" | "ignore" |
|
enabled |
boolean |
|
invalidDate |
"error" | "warn" | "ignore" |
|
ordered |
boolean |
|
unknownMeta |
"error" | "warn" | "ignore" |
ResolvedTypedHoverOptionsResolved typed-hover options.Resolved typed-hover options.
export interface ResolvedTypedHoverOptions| Name | Type | Description |
|---|---|---|
enabled |
boolean |
|
languages |
string[] |
|
tsgoCommandoptional |
string |
ResolvedVersionEntryOne resolved version after prefix and banner sanitization.One resolved version after prefix and banner sanitization.
export interface ResolvedVersionEntry| Name | Type | Description |
|---|---|---|
banner |
VersionBannerKind | false |
|
diroptional |
string |
|
id |
string |
|
label |
string |
|
prefix |
string |
ResolvedVersionsOptionsResolved documentation versioning.Resolved documentation versioning.
export interface ResolvedVersionsOptions| Name | Type | Description |
|---|---|---|
badge |
boolean |
|
current |
string |
|
enabled |
boolean |
|
entries |
ResolvedVersionEntry[] |
|
switcher |
boolean |
ResolvedWikiLinkOptionsResolved wiki-link transform options.Resolved wiki-link transform options.
export interface ResolvedWikiLinkOptions| Name | Type | Description |
|---|---|---|
baseUrl |
string |
|
enabled |
boolean |
ResourcesOptionsOptions for opt-in page-bundle resources and image processing.Options for opt-in page-bundle resources and image processing.
export interface ResourcesOptions| Name | Type | Description |
|---|---|---|
dedupeoptional |
boolean |
Emit identical bytes once as /assets/content/<sha256>.<ext> andrewrite src, poster, and relevant href to that URL.Off unless this is true. resources: true and {} leave it off.Default false |
formatsoptional |
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 pixeltransform is requested. Default ["png", "jpeg", "webp"] |
missingoptional |
"error" | "warn" |
What to do when a relative resource is missing. Default "error" |
widthsoptional |
number[] |
Allowed ?width= / ?w= values. An empty list allows any positivewidth. Default [] |
ReturnDocReturn type documentation.Return type documentation.
export interface ReturnDoc| Name | Type | Description |
|---|---|---|
description |
string |
Prose extracted from @returns / @return documentation. |
type |
string |
Rendered TypeScript type text for the return value. |
SanitizeOptionsOptions for sanitizing rendered HTML. Sanitization happens after Markdown is re…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.
export interface SanitizeOptions| Name | Type | Description |
|---|---|---|
allowedAttributesoptional |
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 |
allowedTagsoptional |
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 |
allowedUrlSchemesoptional |
string[] |
Allowed URL schemes for link-like attributes. Omit to use the built-in safe scheme allow list. Default undefined |
ScopedSearchQueryParsed search query with optional scope prefixes.Parsed search query with optional scope prefixes.
export interface ScopedSearchQuery| Name | Type | Description |
|---|---|---|
scopes |
string[] |
Deduplicated lowercase scope prefixes requested by the query. |
text |
string |
Query text after @scope prefixes have been removed. |
SearchDocumentSearch document structure.Search document structure.
export interface SearchDocument| 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. |
SearchOptionsOptions for full-text search. Search indexes are built from Markdown content at…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.
export interface SearchOptions| Name | Type | Description |
|---|---|---|
appIdoptional |
string |
Hosted search application id. Required when provider is "hosted". Also read fromOX_CONTENT_SEARCH_APP_ID when omitted here. |
enabledoptional |
boolean |
Enable search functionality. Set this to false when config merging requires an object shape but searchshould be disabled. Default true |
endpointoptional |
string |
HTTP endpoint that receives hosted search queries. Also read from OX_CONTENT_SEARCH_ENDPOINT. Defaults to /search whenhosted credentials are present. |
fuzzyoptional |
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 |
hotkeyoptional |
string |
Keyboard shortcut to focus search (without modifier). Use an empty string to let the UI opt out of registering a shortcut. Default '/' |
indexNameoptional |
string |
Hosted search index name. Required when provider is "hosted". Also read fromOX_CONTENT_SEARCH_INDEX_NAME when omitted here. |
limitoptional |
number |
Maximum number of search results. This controls client-side result truncation, not the number of documents in the generated index. Default 10 |
placeholderoptional |
string |
Placeholder text for the search input. This value is embedded in the virtual search module for UI consumers. Default 'Search documentation...' |
prefixoptional |
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 |
provideroptional |
"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' |
publicKeyoptional |
string |
Alias for searchKey.Also read from OX_CONTENT_SEARCH_PUBLIC_KEY when omitted here. |
searchKeyoptional |
string |
Public search-only key for the hosted provider. Write and admin keys are rejected. Also read from OX_CONTENT_SEARCH_KEYwhen omitted here. |
SearchResultSearch result structure.Search result structure.
export interface SearchResult| Name | Type | Description |
|---|---|---|
id |
string |
Matching document identifier. |
matches |
string[] |
Query terms that matched the document. |
scopesoptional |
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. |
SectionIndexOptionsOpt-in generated section index pages.Opt-in generated section index pages.
export interface SectionIndexOptions| Name | Type | Description |
|---|---|---|
styleoptional |
SectionIndexStyle |
How children are rendered. cards is the default when the feature is on.Default "cards" |
SectionIndexStyle = "list" | "cards"Listing style for a generated section index.Listing style for a generated section index.
export type SectionIndexStyle = "list" | "cards"SiteMapsOptionsOpt-in crawl manifests written during SSG.Opt-in crawl manifests written during SSG.
export interface SiteMapsOptions| Name | Type | Description |
|---|---|---|
llmsoptional |
boolean |
Write llms.txt with the site title, description, and page URLs.Default true |
robotsoptional |
boolean |
Write robots.txt with a Sitemap line.Default true |
SsgOptionsStatic Site Generation options. These options control the HTML files emitted at…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.
export interface SsgOptions| Name | Type | Description |
|---|---|---|
a11yoptional |
boolean | A11yOptions |
Opt-in skip link and print styles. Disabled when omitted or false. true enables the default skip linkand print CSS. An object enables the feature and can override the label. Default false |
bareoptional |
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 |
blogoptional |
boolean | BlogOptions |
Opt-in blog index, authors, tags, reading time, and archive. Off by default. true enables defaults. An object enables the featureand overrides only the fields you set. Top-level blog wins when bothare set. Default false |
bodyEndoptional |
string |
Raw markup inserted directly before </body>.Bare mode only. Use it for a site footer, or scripts you inject yourself. Default undefined |
bodyStartoptional |
string |
Raw markup inserted directly after <body>.Bare mode only. Use it for a site header that wraps the rendered page. Default undefined |
breadcrumbsoptional |
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: falsehides the trail on that page. Default false |
cleanoptional |
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 |
contributorsoptional |
boolean | ContributorsOptions |
List unique git authors for each page. Off by default. true enables names only. An object enables thefeature and can set ignore and avatars. Missing .git (forexample a published tarball) yields an empty list and does not fail the build. Default false |
enabledoptional |
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 |
extensionoptional |
string |
File extension used for generated routes. The value should include the leading dot. For example, .html emitsguide.html, while an empty string can be used by custom deployments thatmap extensionless output themselves. Default '.html' |
generateOgImageoptional |
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 — injectthem from your own shell. Default false |
headoptional |
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 |
headValidationoptional |
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 |
jsonLdoptional |
boolean | JsonLdOptions |
Emit JSON-LD structured data ( TechArticle, WebSite, and optionalBreadcrumbList) in the page <head>.Disabled when omitted or false. true enables the defaults. An objectenables the feature and can hide BreadcrumbList or supply a publisher. Publisher fields the site does not set are not invented. Default false |
langoptional |
string |
lang attribute for the generated <html> element.Bare mode uses this verbatim; themed pages derive it from i18n instead.Default "en" |
lastUpdatedoptional |
boolean |
Add each page's last git commit timestamp to the default theme. Default false |
localeSwitcheroptional |
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 arenon-empty. Links use the sibling page when it exists, otherwise the locale root ( /{locale}/ or a configured root).Default false |
markdownSourceoptional |
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 thefeature 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 |
minifyHtmloptional |
boolean |
Minify generated production HTML immediately before files are written. This is separate from Vite's JavaScript/CSS bundle minification and does not affect development responses, XML feeds, JSON feeds, Markdown companions, command output, or binary assets. Default false |
navigationoptional |
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 |
notFoundoptional |
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 |
ogImageoptional |
string |
Static Open Graph image URL used for social sharing. When generateOgImage is enabled, this value is still useful as a fallbackfor pages that cannot produce a generated image. Default undefined |
pageChromeoptional |
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 |
paginationoptional |
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 |
readerChromeoptional |
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 thesame copy and outbound-link transform without adopting the built-in theme. Default false |
renderoptional |
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 headmetadata options do not apply — everything from <html> down is yours.ssg.readerChrome, when enabled, still post-processes the rendereddocument so custom themes share the built-in code-copy and outbound-link implementation. Compose one per layout with createTheme(), and read thecurrent page through usePageProps() / useSiteConfig().`` ts``Default undefined |
routePrefixoptional |
string |
Mount generated page routes under this path, independent from base andoutDir.blog, /blog, and /blog/ all mount under /blog. Page HTML andpage-level assets follow the prefix. Root host files ( _redirects,_headers, root feeds, sitemap index) stay at outDir. base remainsthe public deployment prefix and is not used as an output mount. Frontmatter permalink still wins when permalinks are enabled.Off when omitted. Default undefined |
sectionIndexoptional |
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 thefeature and can switch the listing to list. Existing content indexesare never overwritten. Default false |
siteNameoptional |
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 |
siteUrloptional |
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 |
teamoptional |
boolean | TeamOptions |
Render a static members card grid on pages with layout: team.Off by default. true enables an empty list. An object enables thefeature and supplies members. When the option is off, layout: teamis ignored and the page stays ordinary. Default false |
themeoptional |
ThemeConfig | ThemeConfig[] |
Theme configuration for generated pages. Use defineTheme() to build this object so custom theme modules and thedefault 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``Default defaultTheme |
transformConcurrencyoptional |
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 |
SsgOutputPageInputOne host-owned page for composable SSG outputs (ssg: false). The host renders H…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.
export interface SsgOutputPageInput| Name | Type | Description |
|---|---|---|
descriptionoptional |
string |
|
draftoptional |
boolean |
|
frontmatteroptional |
Record<string, unknown> |
|
htmloptional |
string |
Host-rendered HTML. Required for resource fingerprinting. |
inputPath |
string |
Canonical source file used for companion identity and as a git lastmod source. |
lastUpdatedoptional |
number |
Explicit timestamp in milliseconds. When present, this wins over Git. |
lastUpdatedPathsoptional |
readonly string[] |
Additional files or directories used only for git lastmod freshness. |
locoptional |
string |
Absolute page URL. When omitted, siteUrl + base + urlPath is used. |
outputPathoptional |
string |
Filesystem path of the host-rendered HTML page. |
sourceoptional |
string |
Already-read Markdown source bytes for companions. |
titleoptional |
string |
|
unlistedoptional |
boolean |
|
urlPath |
string |
Published URL path ( guide or /). |
StepsOptionsOptions for opt-in ::: steps ordered lists.Options for opt-in ::: steps ordered lists.
export interface StepsOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable the steps transform when an options object is supplied. Default true |
TaxonomiesOptionsOpt-in term list pages, per-term pages, and related-page lists.Opt-in term list pages, per-term pages, and related-page lists.
export interface TaxonomiesOptions| Name | Type | Description |
|---|---|---|
relatedLimitoptional |
number |
Maximum related pages injected into a source page. Default 5 |
taxonomiesoptional |
string[] |
Frontmatter keys (and URL prefixes) to read terms from. Default ["tags", "categories"] |
TeamLinkOne link on a team member card.One link on a team member card.
export interface TeamLink| Name | Type | Description |
|---|---|---|
href |
string |
Destination. Only https: or a site-relative / path is emitted. |
label |
string |
Visible label. Escaped in HTML. |
TeamMemberOne person on the team page.One person on the team page.
export interface TeamMember| Name | Type | Description |
|---|---|---|
avataroptional |
string |
Avatar URL. Only https: or a site-relative / path is emitted. |
linksoptional |
TeamLink[] |
Optional profile or social links. |
name |
string |
Display name. Escaped in HTML. |
roleoptional |
string |
Optional role or title. Escaped in HTML. |
ThrowsDocException/error documentation.Exception/error documentation.
export interface ThrowsDoc| Name | Type | Description |
|---|---|---|
description |
string |
Prose extracted from @throws / @exception documentation. |
typeoptional |
string |
Rendered TypeScript type text for the thrown value, when documented. |
TimelineOptionsOptions for opt-in static timelines.Options for opt-in static timelines.
export interface TimelineOptions| Name | Type | Description |
|---|---|---|
emptyoptional |
"error" | "warn" | "ignore" |
Diagnostics for timeline blocks without items. Default "error" |
enabledoptional |
boolean |
Enable ::: timeline blocks.Default true when the options object is supplied. |
invalidDateoptional |
"error" | "warn" | "ignore" |
Diagnostics for malformed YYYY, YYYY-MM, or YYYY-MM-DD item dates.Default "error" |
orderedoptional |
boolean |
Render timelines as ordered lists unless a block overrides it. Default true |
unknownMetaoptional |
"error" | "warn" | "ignore" |
Diagnostics for unsupported item metadata. Default "error" |
TocEntryTable of contents entry.Table of contents entry.
export interface TocEntry| Name | Type | Description |
|---|---|---|
children |
TocEntry[] |
Child entries. |
depth |
number |
Heading depth (1-6). |
slug |
string |
Slug/ID for linking. |
text |
string |
Heading text. |
TransformContextTransform context passed to transformers.Transform context passed to transformers.
export interface TransformContext| Name | Type | Description |
|---|---|---|
filePath |
string |
File path being processed. |
frontmatter |
Record<string, unknown> |
Frontmatter data. |
options |
ResolvedOptions |
Resolved plugin options. |
TransformResultTransform result.Transform result.
export interface TransformResult| 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). |
mapoptional |
null |
Source map (null means no source map). |
toc |
TocEntry[] |
Table of contents. |
TypedHoverOptionsOptions for opt-in typed hover overlays on TypeScript fences. Hover strings are…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.
export interface TypedHoverOptions| Name | Type | Description |
|---|---|---|
enabledoptional |
boolean |
Enable typed hover overlays. Default true when the object form is used |
languagesoptional |
string[] |
Fence languages that can receive hover payloads. Language names are compared case-insensitively. Default ['ts', 'tsx'] |
tsgoCommandoptional |
string |
Path to the tsgo binary used to compute hover types.When omitted, the bundled @typescript/native-preview executable is used. |
TypeParamDocType parameter documentation (<T extends C = D>).Type parameter documentation (<T extends C = D>).
export interface TypeParamDoc| Name | Type | Description |
|---|---|---|
constraintoptional |
string |
Constraint after extends, when present. |
defaultoptional |
string |
Default type after =, when present. |
description |
string |
Description from a @typeParam / @template tag (left out of docs.json when empty). |
name |
string |
Type parameter name, such as T. |
typesType definitions for @ox-content/vite-pluginType definitions for @ox-content/vite-plugin
VersionEntryOne published or snapshot version of a docs tree.One published or snapshot version of a docs tree.
export interface VersionEntry| Name | Type | Description |
|---|---|---|
banneroptional |
VersionBannerKind | false |
Optional status banner for pages in this version. |
diroptional |
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 thesite root. |
VersionsOptionsOpt-in documentation versioning. Off by default. true enables a single current…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.
export interface VersionsOptions| Name | Type | Description |
|---|---|---|
badgeoptional |
boolean |
Show unreleased / unmaintained badges in the dropdown. @default true |
currentoptional |
string |
Id of the live tree being built from srcDir. |
entriesoptional |
VersionEntry[] |
Declared versions. Historical snapshots must set dir. |
switcheroptional |
boolean |
Render the header version dropdown. @default true |
WikiLinkOptionsOptions for expanding Obsidian-style wiki links. The transform accepts [target]…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.
export interface WikiLinkOptions| Name | Type | Description |
|---|---|---|
baseUrloptional |
string |
Base URL prepended to resolved wiki-link targets. When omitted, the top-level base option is used.Default options.base |