fetchGitHubResource(resource: GitHubResourceRef, options: Required<GitHubOptions>): Promise<GitHubResourceData | null>Fetch public GitHub issue, pull request, commit, discussion, or gist metadata.fetchGitHubSource(source: GitHubSourceRef, options: Required<GitHubOptions>): Promise<GitHubSourceData | null>Fetch source file data from GitHub API.fetchRepoData(repo: string, options: Required<GitHubOptions>): Promise<GitHubRepoData | null>Fetch repository data from GitHub API.prefetchGitHubRepos(repos: string[], options?: GitHubOptions): Promise<Map<string, GitHubRepoData | null>>Pre-fetch all GitHub repos data.prefetchGitHubResources(resources: GitHubResourceRef[], options?: GitHubOptions): Promise<Map<string, GitHubResourceData | null>>Pre-fetch all GitHub resource cards.prefetchGitHubSources(sources: GitHubSourceRef[], options?: GitHubOptions): Promise<Map<string, GitHubSourceData | null>>Pre-fetch all GitHub source files.apply-permalinksApplies resolved permalinks / cascade to SSG pages and collection entries.applyCollectionRoutes(manifest: CollectionManifest, permalinks?: ResolvedPermalinksOptions | null, cascade?: ResolvedCascadeOptions | null): { manifest: CollectionManifest; errors: string[] }Rewrites collection path / stem / inherited frontmatter.applySsgPageRoutes(input: { pages: readonly SsgRoutablePage[]; permalinks?: ResolvedPermalinksOptions | null; cascade?: ResolvedCascadeOptions | null; srcDir: string; outDir: string; base: string; extension: string; siteUrl?: string; }): { pages: SsgRoutablePage[]; errors: string[] }Rewrites SSG routePaths from resolved permalinks / slugs.remapNavGroups<T extends NavGroup>(nav: T[], kept: readonly { fileUrl: string; urlPath: string; href: string }[], skippedFileUrls: readonly string[]): T[]Updates auto-nav hrefs after permalinks change a page URL.SsgRoutablePageSSG page shape that can have its routePaths rewritten.collectGitHubRepos(html: string): Promise<string[]>Collect all GitHub repos from HTML for pre-fetching.collectGitHubResources(html: string): Promise<GitHubResourceRef[]>Collect all GitHub issue, pull request, commit, discussion, and gist refs.collectGitHubSources(html: string): Promise<GitHubSourceRef[]>Collect all GitHub source references from HTML for pre-fetching.blockEmbedTags(): Promise<ReadonlySet<string>>Every tag whose embed is a block, taken from the registry rather than copied. A hand-ke…const TYPESCRIPT_ONLY_BLOCK_EMBED_TAGS = ["github", "ogcard", "reddit", "youtube"] as constBlock embeds this package owns, which the Rust provider registry cannot name. NotByAI i…blog-feed-datePublication dates from RSS / Atom items.blog-feed-fetchBuild-time fetch of configured blog feeds. Never used for document URLs.installBlogFeedNetwork(network: BlogFeedNetwork): voidTest hook. Production builds leave this empty.blog-feed-parseRSS 2.0 / Atom 1.0 item extraction. HTML documents are rejected.blog-feed-urlSafe-URL checks for configured external blog feeds.const CONTROL_CHARS = /[\n\r\t\0]/Safe-URL checks for configured external blog feeds.blog-feedsLoad, normalize, and merge configured external blog feeds.blog-htmlEscaped blog index, tag, archive, and post-meta HTML.BlogSourcePageOne listed post considered for blog surfaces.isSafeBlogUrl(value: string): booleanhttps: or a same-origin path starting with / but not //.blog-optionsBlog option resolution.resolveBlogCollectionName(requested: string | undefined, collectionNames: readonly string[]): string | undefinedPicks a collection named blog, else the only configured collection. An explicit name al…appendBlogPages(input: { generatedPages: Array<{ inputPath: string; outputPath: string; html: string }>; listedPages: readonly BlogSourcePage[]; options?: ResolvedBlogOptions; collections?: ResolvedCollectionsOptions; srcDir: string; outDir: string; base: string; render: (page: BlogGeneratedPage) => Promise<string>; errors: string[]; feedNetwork?: BlogFeedNetwork; }): Promise<void>Renders index, tag, and archive pages and appends them to the build.blog-pagesGenerated blog index, tag, and archive pages.BlogGeneratedPageSynthetic page passed back to generateHtmlPage.toBlogProcessResult(page: BlogGeneratedPage): { inputPath: string; routePaths: { outputPath: string; urlPath: string; href: string; ogImagePath: string; ogImageUrl: string; }; transformedHtml: string; title: string; frontmatter: Record<string, unknown>; toc: []; }Maps a generated blog page onto the SSG render shape.blog-postsBlog post selection, tags, authors, and dates.blog-readingDeterministic blog reading-time estimates.const LATIN_WORDS_PER_MINUTE = 200Deterministic blog reading-time estimates.browserChromium browser session with automatic cleanup via Explicit Resource Management. Usage…OgBrowserPool extends AsyncDisposableA set of independent sessions, closed together.OgBrowserSession extends AsyncDisposableA browser session that can render HTML pages to PNG. Implements AsyncDisposable for aut…openBrowser(): Promise<OgBrowserSession | null>Opens a Chromium browser and returns a session for rendering OG images. Returns null if…openBrowserPool(size: number): Promise<OgBrowserPool | null>Opens up to size independent browsers. Rendering does not parallelize inside one browse…PooledPageA pooled page and the public directory its route handler was set up for.cacheContent-hash based caching for OG images. Uses SHA256 of (template source + props + opt…computeCacheKey(templateSource: string, props: Record<string, unknown>, width: number, height: number): stringComputes a cache key from template + props + options.getCached(cacheDir: string, key: string): Promise<Buffer | null>Checks if a cached PNG exists for the given key. Returns the cached file path if found,…isCached(cacheDir: string, key: string): Promise<boolean>Whether a cached PNG exists, without reading it. Deciding whether the browser has to st…writeCache(cacheDir: string, key: string, png: Buffer): Promise<void>Writes a PNG buffer to the cache.isLinkLabel(markdown: string, match: RegExpMatchArray): booleanA bracketed span that a destination or reference immediately follows is a Markdown link…rewriteCollectionAssetUrls(input: RewriteCollectionAssetUrlsInput): RewriteCollectionAssetUrlsResultRewrites host-rendered HTML references from collection aliases to their content-address…CollectionAssetInputOne collection file and the public URLs that should expose it.CollectionAssetManifestA reusable asset plan for a custom host's build writer and development middleware. Sour…CollectionAssetManifestEntryA source file, its normalized aliases, and its content-addressed URL.createCollectionAssetsMiddleware(manifest: CollectionAssetManifest): AssetMiddlewareCreate Connect-compatible middleware that serves planned aliases and their content-addr…planCollectionAssets(input: PlanCollectionAssetsInput): Promise<CollectionAssetManifest>Hash collection files and normalize their public aliases without taking over the host r…PlanCollectionAssetsInputInputs for a content-addressed collection asset manifest.writeCollectionAssets(input: WriteCollectionAssetsInput): Promise<WriteCollectionAssetsResult>Write each content-addressed target once, then materialize its aliases with hard links…contributorsOpt-in git contributor list helpers. Resolution and ignore filtering live here. git log…resolveContributorsOption(value: boolean | ContributorsOptions | undefined): ResolvedContributorsResolves ssg.contributors with defaults. false / omitted stays off. true enables names…cross-reference-htmlThe escaping and prose-scanning helpers the citation pass still needs. The cross-refere…const PROTECTED_TEXT_RE = /<!--[\s\S]*?-->|<(pre|code|script|style|textarea|a)\b[\s\S]*?<\/\1>/giThe escaping and prose-scanning helpers the citation pass still needs. The cross-refere…transformText(html: string, replacer: (text: string) => string): stringRuns replacer over every stretch of prose, skipping verbatim elements.createDevServerCache(): DevServerCacheCreate a dev server cache instance.createDevServerMiddleware(options: ResolvedOptions, root: string, cache: DevServerCache): Connect.NextHandleFunctionCreate the dev server middleware for SSG page serving.dev-serverDev server middleware for ox-content SSG. Serves fully-rendered HTML pages (with naviga…DevServerCacheDev server state for caching.injectViteHmrClient(html: string): stringInject Vite HMR client script into the HTML.invalidateNavCache(cache: DevServerCache): voidInvalidate navigation cache (called on file add/unlink).invalidatePageCache(cache: DevServerCache, filePath: string): voidInvalidate page cache for a specific file (called on file change).resolveMarkdownFile(url: string, srcDir: string, extensions: readonly string[]): Promise<string | null>Resolve a request URL to a markdown file path. Returns null if no matching file exists.resolveSiteName(options: ResolvedOptions, root: string): Promise<string>Resolve site name from options or package.json.shouldSkip(url: string): booleanCheck if a request URL should be skipped by the dev server middleware.const VITE_INTERNAL_PREFIXES = ["/@vite/", "/@fs/", "/@id/", "/__"]Vite internal URL prefixes to skip.docsSource Documentation Extraction and Generation This module provides comprehensive tools…existingGeneratedAt(outDir: string): string | undefinedKeep docs.json's timestamp stable across regenerations of the same tree.extractDocs(srcDirs: string[], options: ResolvedDocsOptions): Promise<ExtractedDocs[]>Extracts JSDoc documentation from source files in specified directories. This function…generateMarkdown(docs: ExtractedDocs[], options: ResolvedDocsOptions): Record<string, string>Generates Markdown documentation from extracted docs.generateOpenApiDocs(options: ResolvedDocsOptions, root = process.cwd()): GeneratedOpenApiDocsGenerates Markdown documentation from local OpenAPI 3.0/3.1 files.resolveDocsOptions(options: false): falseResolves docs options with defaults.writeDocs(docs: Record<string, string>, outDir: string, extractedDocs?: ExtractedDocs[], options?: ResolvedDocsOptions, extraNav: DocsNavigationItem[] = []): Promise<void>Writes generated documentation to the output directory.document-importsResolve MDX component imports relative to the document that declared them. Only ./ and…document-islandsCombine document-local import resolution with MDX island discovery.embed-transformReserve first-party embed components so MDX island lowering cannot swallow them. Rust s…const PAYLOAD_SCRIPT = /^\s*<script type="application\/json">[\s\S]*?<\/script>/Reserve first-party embed components so MDX island lowering cannot swallow them. Rust s…const RESERVED_BUILTIN_COMPONENTS = [ "GitHub", "OgCard", "Tweet", "XPost", "Reddit", "Bluesky", "GoogleMaps", "Qiita", "Zenn", "NpmPackage", "CratesIo", "PyPI", "DockerHub", "CodePen", "JSFiddle", "Observable", "Vimeo", "Twitch", "Discord", "Fediverse", "Mastodon", "Misskey", "Mixi2", "Facebook", "Threads", "Instagram", "Spotify", "AppleMusic", "SpeakerDeck", "Audio", "Video", "StackBlitz", "WebContainer", "YouTube", "NotByAI", ] as constCanonical PascalCase names for first-party embed / media components. Keep in sync with…restoreReservedBuiltinIslands(html: string, localNames?: Iterable<string>): stringReplace reserved built-in islands with the original HTML tags so embed transforms can s…createEnvironmentPlugins(options: ResolvedOptions)Environment plugin factory. Creates plugins specific to the Markdown environment.createMarkdownEnvironment(options: ResolvedOptions, runtime: OxContentJavaScriptRuntime = detectJavaScriptRuntime()): EnvironmentOptionsCreates the Markdown processing environment configuration. This environment is used for…createTransformOptions(ctx: EnvironmentTransformContext, options: ResolvedOptions): ResolvedOptionsCreates environment-aware transform options.detectJavaScriptRuntime(): OxContentJavaScriptRuntimeDetects the runtime that is executing Vite.environmentVite Environment API integration for Ox Content. Creates a dedicated environment for Ma…EnvironmentTransformContextEnvironment-specific module transformer. This is called during the transform phase to p…prerender(files: string[], _options: ResolvedOptions): Promise<Map<string, string>>Runs pre-render for SSG. This function is called during build to pre-render all Markdow…createFallbackCard(repo: string): ElementCreate fallback element when repo data is unavailable.parseDate(value: string | undefined): ParsedDate | undefinedParse a feed date: epoch seconds, epoch milliseconds, or a civil date-time with an opti…feed-formatShapes the feed pipeline passes between item selection and the native renderer. The bod…FeedChannelExtrasChannel fields the formats emit when the standard has a matching slot.feeds-nativeBridges the resolved feed inputs onto generateFeedBodies. The TypeScript renderer this…nativeItem(item: FeedEntry): Record<string, unknown>FeedEntry carries the date already parsed into UTC components; the native side takes th…feedsOpt-in RSS / Atom / JSON Feed helpers. Bodies come from oxcontentssg::generate_feeds…FeedsRenderInputInputs for rendering feed bodies.FeedsRenderResultRendered feed bodies, or a skip warning.generateFeeds(input: FeedsRenderInput): FeedsRenderResultBuilds RSS / Atom / JSON Feed bodies without writing files.resolveFeedCollectionName(requested: string | undefined, collectionNames: readonly string[]): string | undefinedPicks content, else the first configured collection name.resolveFeedsOptions(value: boolean | FeedsOptions | undefined): ResolvedFeedsOptionsResolves feeds with defaults. false / omitted stays off. true enables all three formats…header-chromeOpt-in header nav, announcement, and per-page chrome helpers.HeaderNavItemHeader nav link or dropdown.LocaleLabel = string | Record<string, string>Plain label or locale map ({ en: "Guide", ja: "ガイド" }).PageChromeFlagsPer-page frontmatter chrome flags. false hides that region.parsePageChromeFlags(frontmatter: Record<string, unknown>): PageChromeFlagsReads hide flags from frontmatter. Non-boolean values are ignored.ResolvedHeaderNavItemNav item after locale maps are flattened to strings.resolveHeaderNavItems(items: HeaderNavItem[] | undefined, locale?: string, defaultLocale?: string): ResolvedHeaderNavItem[] | undefinedResolves locale maps so NAPI always receives string labels.resolveLocaleLabel(text: LocaleLabel, locale?: string, defaultLocale?: string): stringPicks the exact locale, its language, the default locale, then the first non-empty own…resolvePageChromeOption(value: boolean | Record<string, unknown> | undefined): booleanfalse or omitted stays off. true or {} enables default flag reading.ThemeAnnouncementAnnouncement bar. Text is escaped; no raw HTML slot.getTextContent(node: Element | Root): stringExtract text content from a hast node.highlight-nativeThe native tree-sitter highlighting path, plus the small hast helpers the per-block wal…highlightDocumentNatively(html: string): Promise<NativeDocument | null>Highlights every code block in a rendered document in one native call. Returns the rewr…highlightNatively(code: string, lang: string): string | nullHighlights with the native tree-sitter engine, or null when it has no grammar for lang.…NativeDocumentWhat highlightDocumentNatively produced for a page.PendingBlockA block the native pass left unhighlighted (no grammar).highlightSyntax highlighting with the native tree-sitter engine. Markup uses <pre class="ox-high…highlightCode(html: string): Promise<string>Apply native tree-sitter highlighting to HTML. Tries the document pass first. If that p…highlightPageHtml(html: string, mergeHighlightedCodeBlocks: (originalHtml: string, highlightedHtml: string) => string): Promise<string>Highlight every code block in a rendered page, preserving original classes and per-line…rehypeNativeHighlight()Per-block walk used when the native document pass cannot read the markup. Unknown langu…embedSearchJson(value: unknown): stringJSON-embeds a value so it stays inert inside a script tag.createI18nPlugin(resolvedOptions: ResolvedOptions): PluginCreates the i18n sub-plugin for the Vite plugin array.generateI18nModule(options: ResolvedI18nOptions, root: string): stringGenerates the virtual module for i18n configuration.i18ni18n plugin for Ox Content. Provides: - Dictionary loading and validation at build time…resolveI18nOptions(options: I18nOptions | false | undefined): ResolvedI18nOptions | falseResolves i18n options with defaults.icons-cssResolve Iconify JSON collections and emit CSS-mask rules. Collections come from install…iconsOpt-in self-hosted Iconify CSS for used and safelisted icons. Collection lookup stays o…renderSelfHostedIconsCss(input: RenderSelfHostedIconsCssOptions): Promise<RenderSelfHostedIconsCssResult>Render resolved icon CSS. Missing collections or names become errors.writeSelfHostedIcons(input: WriteSelfHostedIconsOptions): Promise<WriteSelfHostedIconsResult>Copy resolved icon CSS into outDir. Missing collections or names become errors.generateVirtualModule(path: string, options: ResolvedOptions): stringGenerates virtual module content.indexVite Plugin for Ox Content Uses Vite's Environment API for SSG-focused Markdown process…oxContent(options: OxContentOptions = {}): Plugin[]Creates the Ox Content Vite plugin.indexIsland Architecture support for ox-content Provides parsing and transformation of <Isla…computeTemplateSource(options: ResolvedOgImageOptions, root: string): Promise<string>Computes a stable template source identifier for cache keys. For custom templates, hash…createSvelteCompilerPlugin(): import("rolldown").PluginCreates a rolldown plugin that compiles Svelte SFCs using svelte/compiler.createVueCompilerPlugin(): import("rolldown").PluginCreates a rolldown plugin that compiles Vue SFCs using @vue/compiler-sfc.defaultConcurrency(): numberHow many pages to render at once when the caller does not say. Rendering was serial by…generateOgImages(pages: OgImagePageEntry[], options: ResolvedOgImageOptions, root: string): Promise<OgImageResult[]>Generates OG images for a batch of pages. Manages the full lifecycle: resolve template…getVizejsPlugin(): Promise<import("rolldown").Plugin[]>Loads @vizejs/vite-plugin as a rolldown plugin for Vue SFC compilation.isBareSpecifier(id: string): booleanWhether id is a bare specifier, and so resolvable at runtime rather than something the…KeyedPageEntry extends OgImagePageEntryA page entry with its cache key computed once.mapWithSessions<Item, Result>(items: readonly Item[], sessions: readonly OgBrowserSession[], render: (item: Item, session: OgBrowserSession) => Promise<Result>): Promise<Result[]>Runs render over items, one at a time per session, in input order. A shared cursor rath…OgImagePageEntryA single page entry for batch OG image generation.OgImageResultResult of OG image generation for a single page.const OX_CONTENT_PACKAGE = /^@ox-content\/vite-plugin(\/.*)?$/Matches this package and every subpath it exports. A template's natural runtime is what…renderSinglePage(entry: KeyedPageEntry, templateFn: OgImageTemplateFn, options: ResolvedOgImageOptions, cacheDir: string, session: OgBrowserSession, publicDir?: string): Promise<OgImageResult>Renders a single page to PNG, with cache support.renderSingleSatoriPage(entry: KeyedPageEntry, templateFn: OgImageTemplateFn, options: ResolvedOgImageOptions, cacheDir: string, root: string): Promise<OgImageResult>Renders a single page to PNG using Satori, with cache support.resolveReactTemplate(templatePath: string, root: string): Promise<OgImageTemplateFn>Resolves a React (.tsx/.jsx) template via SSR. Bundles with rolldown (JSX transform), t…resolveSvelteTemplate(templatePath: string, root: string): Promise<OgImageTemplateFn>Resolves a Svelte SFC template via SSR. Compiles the SFC with svelte/compiler (server m…resolveTemplate(options: ResolvedOgImageOptions, root: string): Promise<OgImageTemplateFn>Resolves the template function from options. Dispatches by file extension: - .vue → Vue…resolveTsTemplate(templatePath: string, options: ResolvedOgImageOptions, root: string): Promise<OgImageTemplateFn>Resolves a plain TypeScript template (existing behavior).resolveVueTemplate(templatePath: string, options: ResolvedOgImageOptions, root: string): Promise<OgImageTemplateFn>Resolves a Vue SFC template via SSR. Compiles the SFC with @vue/compiler-sfc (or @vizej…tryServeAllFromCache(pages: KeyedPageEntry[], cacheDir: string): Promise<OgImageResult[] | null>Serves every page from cache when all of them are present. The probe is an existence ch…tsTemplateBundleOptions(templatePath: string)Rolldown input options for a .ts template bundle. A .ts template is the framework-less…withCacheKeys(pages: OgImagePageEntry[], templateSource: string, options: ResolvedOgImageOptions): KeyedPageEntry[]Attaches the cache key to each entry. The key is a SHA-256 over the template source and…indexox-content Built-in Plugins All plugins are designed with No-JavaScript-First principle…normalizeSelfClosingEmbeds(html: string): stringCustom embed tags are not HTML void elements, so a self-closing authoring form like <Gi…TransformAllOptions extends MediaEmbedOptionsTransform all plugin components in HTML. Call this during SSG build to process all plug…transformAllPlugins(html: string, options: TransformAllOptions = {}): Promise<string>Transform all enabled plugins in HTML content.transformBuiltinEmbeds(html: string, options: { github: GitHubOptions | false; openGraph: OgpOptions | false; pm?: PmOptions | false; /** * Document-local import bindings. A reserved built-in name in this set * stays an MDX island instead of running the first-party embed transform. */ localNames?: Iterable<string>; } & MediaEmbedOptions): Promise<string>Transform built-in embed components in HTML content.const TYPESCRIPT_ONLY_EMBED_TAGS = ["GitHub", "OgCard", "Reddit", "YouTube", "NotByAI"] as constEmbed tags this package owns, which the Rust provider registry cannot name. Everything…interopInterop helpers for loading ESM-only dependencies from the CommonJS build.interopDefault<T>(value: T): TUnwrap the default export of an ESM-only dependency. The CommonJS build (dist/index.cjs…island-codegenEmit static component imports for framework Markdown modules. Document-local bindings w…island-ssrOptional adapter-side island SSR. Framework plugins may supply renderIsland to replace…RenderIslandFn = (name: string, props: Record<string, unknown>, filePath: string, slotHtml?: string) => string | Promise<string>Optional adapter-side island SSR. Framework plugins may supply renderIsland to replace…jsx-dev-runtimeDevelopment-runtime entry point for the static HTML JSX transform. TypeScript's react-j…jsxDEV(type: JSXElementType, props: JSXProps, key?: string, _isStaticChildren?: boolean, _source?: JSXSource, _self?: unknown): JSXNodeCreates a JSX element in development mode. The transform passes isStaticChildren, sourc…JSXSourceSource position the dev transform attaches to each element.const ATTR_ALIASES: Record<string, string>React prop names whose HTML spelling is not the lowercased identifier.each<T>(items: T[], render: (item: T, index: number) => JSXNode): JSXNodeMaps over an array and renders each item.escapeHtml(str: string): stringEscapes HTML special characters to prevent XSS.Fragment({ children }: { children?: JSXChild }): JSXNodeFragment component - renders children without a wrapper element.jsx(type: JSXElementType, props: JSXProps, _key?: string): JSXNodeCreates a JSX element. This is the core function called by the JSX transform.jsx-htmlCustom JSX Runtime for Static HTML Generation This module provides a JSX runtime that o…JSXChild = string | number | boolean | null | undefined | JSXNode | JSXChild[]Valid JSX child types.JSXElementType = string | ((props: Record<string, unknown>) => JSXNode)JSX element type - either a string (intrinsic) or a function component.JSXNodeJSX node - the result of JSX expressions.JSXPropsProps with children.jsxs(type: JSXElementType, props: JSXProps, key?: string): JSXNodeCreates a JSX element with static children. Called by the JSX transform for elements wi…raw(html: string): JSXNodeCreates raw HTML without escaping. Use with caution - only for trusted content.renderAttr(name: string, value: unknown): stringRenders an attribute value to a string.renderChildren(children: JSXChild): stringRenders children to HTML string.renderToString(node: JSXNode): stringRenders a JSX node to an HTML string.const SVG_CAMEL_CASE = new Set(["viewBox"])SVG attributes that stay camelCase in HTML (they are case-sensitive).toHtmlAttr(name: string): stringConverts a JSX/React prop name to the HTML attribute the runtime emits. HTML attributes…when(condition: boolean, content: JSXNode): JSXNodeConditionally renders content.jsx-runtimeAutomatic-runtime entry point for the static HTML JSX transform. jsxImportSource makes…jsx.dJSX Type Definitions for Static HTML Generation These types enable TypeScript support f…lintMarkdownFile(filePath: string, options: MarkdownLintFileOptions = {}): Promise<MarkdownLintFileResult>Lints a single Markdown file using project-style include/exclude settings. If the file…lintMarkdownFiles(options: MarkdownLintFileOptions = {}): Promise<MarkdownLintFilesResult>Lints all Markdown files matched by the configured include/exclude patterns.MarkdownLintFileDiagnostic extends MarkdownLintDiagnosticA lint diagnostic annotated with file metadata.MarkdownLintFileOptions extends MarkdownLintOptionsFile-oriented Markdown lint options for end-user configuration. This extends the conten…MarkdownLintFileResult extends MarkdownLintResultLint result for a single file.MarkdownLintFilesResultAggregated lint result for multiple files.shouldLintMarkdownFile(filePath: string, options: MarkdownLintFileOptions = {}): booleanReturns true if the file path is included by the configured glob filters.lintMarkdown(source: string, options: MarkdownLintOptions = {}): MarkdownLintResultLints Markdown prose with the Rust-backed built-in rule engine.lintMarkdownAsync(source: string, options: MarkdownLintOptions = {}): Promise<MarkdownLintResult>Async Markdown linter that supports opt-in standard dictionaries.lintMarkdownDocumentsAsync(sources: string[], options: MarkdownLintOptions = {}): Promise<MarkdownLintResult[]>Internal batched Markdown linting entry point used by file-based workflows.MarkdownLintDiagnosticA single Markdown lint diagnostic.MarkdownLintDictionaryOptionsAdditional dictionary configuration for the Markdown linter.MarkdownLintOptionsOptions for linting Markdown documents.MarkdownLintResultMarkdown lint report.MarkdownLintRuleOptionsRule switches for Markdown linting.MarkdownLintStandardDictionaryOptionsOpt-in standard dictionary sources. The default provider uses CSpell dictionary package…locale-navRewrites default-theme nav hrefs to the current locale sibling when it exists.localizeHeaderNavItems(items: HeaderNavItem[] | undefined, options: LocalizeNavOptions): HeaderNavItem[] | undefinedResolves header labels and rewrites link values the same way as the sidebar.localizeNavGroups<T extends LocalizableNavGroup>(groups: T[], options: LocalizeNavOptions): T[]Resolves authored sidebar label maps and prefixes hrefs/paths with the current locale w…resolveLocaleSwitcherOption(value: boolean | Record<string, unknown> | undefined): booleanResolves ssg.localeSwitcher. Omitted / false stay off. true or an object enables the co…SsgLocalePathSibling page or locale-root href for one locale in the default-theme switcher.buildMarkdownSourceIndex(input: { files: readonly string[]; srcDir: string; permalinks?: ResolvedPermalinksOptions | null; cascade?: ResolvedCascadeOptions | null; publishState?: ResolvedPublishStateOptions; }): Promise<Map<string, MarkdownSourceIndexEntry>>Builds a companion index from source files without transforming Markdown.injectMarkdownSourceAlternate(html: string, href: string): stringInserts <link rel="alternate" type="text/markdown"> before </head>.isMarkdownSourceRequest(pathname: string): booleanTrue when the request pathname is a .md companion URL.markdown-sourceOpt-in Markdown source companions written beside generated HTML. Copies already-read so…markdownSourceHref(urlPath: string, base: string): string | undefinedPublic companion href, including base. Always ends in .md.markdownSourceHrefForPage(input: { source: string; fileUrl: string; frontmatter: Record<string, unknown>; base: string; permalinks?: ResolvedPermalinksOptions | null; cascade?: ResolvedCascadeOptions | null; publishState?: ResolvedPublishStateOptions; }): string | undefinedCompanion href for one page after permalink / publish-state checks.MarkdownSourceIndexEntryOne entry in the dev-server companion index.markdownSourceOutputPath(outDir: string, urlPath: string): string | undefinedFilesystem path for a companion, or undefined when it would escape outDir.MarkdownSourcePageInputOne page that may receive a source companion.parseSourceFrontmatter(source: string): Record<string, unknown>Frontmatter keys only — not a Markdown parse.resolveMarkdownSourceOptions(value: boolean | MarkdownSourceOptions | undefined): ResolvedMarkdownSourceOptionsResolves ssg.markdownSource with defaults. false / omitted stays off. true enables comp…resolveMarkdownSourceRequest(pathname: string, index: ReadonlyMap<string, MarkdownSourceIndexEntry>): MarkdownSourceIndexEntry | undefinedLooks up a companion after the site base has been stripped.shouldPublishMarkdownSource(frontmatter: Record<string, unknown>, publishState?: ResolvedPublishStateOptions): booleanWhether this page may publish a companion. Draft and unlisted source is never emitted.…writeMarkdownSourceFiles(input: WriteMarkdownSourceFilesInput): Promise<{ files: string[]; errors: string[] }>Writes enabled companions from already-read source bytes.WriteMarkdownSourceFilesInputInputs for writing companions next to generated HTML.enhanceMarkdownTables(root?: ParentNode, options: MarkdownTableEnhancementOptions = {}): numberMakes overflowing Markdown tables keyboard-scrollable without wrapping or replacing the…isMdxFilePath(filePath: string): booleanReturns true when a resource id points at an MDX source file.resolveMdxForFilePath(filePath: string, configured?: boolean): booleanExplicit configuration wins; otherwise MDX follows the source extension.copyKatexAssets(outDir: string, formats: KatexFontFormats = "woff2"): Promise<string[]>Copies katex.min.css and the requested font formats into the SSG output. Returns an emp…createKatexAssetsPlugin(): PluginDev-server middleware that serves /_oxkatex__/* from katex/dist.const FONT_FORMATS = { woff2: [".woff2"], all: [".woff2", ".woff", ".ttf"] } as constFont formats KaTeX ships, newest first.KatexFontFormats = keyof typeof FONT_FORMATSWhich of KaTeX's font formats to emit.math-assetsServe and copy KaTeX CSS/fonts only when the optional katex package exists.decodeHtmlAttr(value: string): stringDecodes the attribute back to the TeX the author wrote. The placeholder is escaped by R…mathBuild-time KaTeX rendering for opt-in $…$ / $$…$$ math. KaTeX is an optional peer. Site…MathErrorPolicy = "literal" | "error" | "render"What to do with a $…$ run KaTeX cannot parse.MathRenderFailureOne $…$ run KaTeX refused, for the caller to report.renderKatexMath(html: string, onError: MathErrorPolicy = "literal", failures?: MathRenderFailure[]): Promise<string>Replaces rust ox-math placeholders with static KaTeX HTML. Leaves the escaped TeX fallb…resolveKatexDist(): string | nullDirectory that contains katex.min.css and fonts/, or null.collectMdxIslandNamesFromHtml(html: string): string[]Collect data-ox-island names from Rust-rendered HTML. Used when an AST walk is unavaila…collectMdxJsxNamesFromAst(ast: unknown): string[]Collect named MDX JSX tags from a parsed mdast tree (JSON from NAPI parse()). Fragments…ComponentRegistry = Readonly<Record<string, unknown>> | ReadonlyMap<string, unknown> | Iterable<string>Global component map: object, Map, or name list.discoverRegisteredMdxComponents(input: DiscoverRegisteredMdxComponentsInput): Promise<string[]>Resolve registered island names for an MDX document. Prefers a NAPI parse() AST walk. F…intersectHydratableComponentNames(names: Iterable<string>, components: ComponentRegistry, localNames?: Iterable<string>): string[]Keep names that are either globally registered or document-local bindings.intersectRegisteredComponentNames(names: Iterable<string>, components: ComponentRegistry): string[]Keep names that exist on the global component map, in first-seen order.mdx-islandsDiscover registered MDX islands from the mdast tree or rendered HTML. Framework plugins…hasMediaMarker(html: string): Promise<boolean>True when the document contains any tag the transform could rewrite. The list comes fro…const TYPESCRIPT_ONLY_TAGS = ["reddit"] as constProviders that live in this package rather than the Rust registry, so the registry cann…reportRefusedEmbeds(diagnostics: readonly { provider: string; url?: string | null; line: number; fallback: string }[]): voidWarns about tags an enabled provider refused. A refusal is invisible in the output — th…mermaid-protectProtects generated static SVG content from rehype HTML5 parser corruption. rehypeParse…MermaidSvgProtectionProtects generated static SVG content from rehype HTML5 parser corruption. rehypeParse…protectMermaidSvgs(html: string): MermaidSvgProtectionExtract <div class="ox-mermaid">...</div> blocks and replace with HTML comment placehol…protectStaticDiagramSvgs(html: string): MermaidSvgProtectionExtract generated static diagram blocks and replace them with HTML comment placeholders…restoreMermaidSvgs(html: string, svgs: Map<string, string>): stringRestore protected mermaid SVG blocks from placeholders.restoreStaticDiagramSvgs(html: string, svgs: Map<string, string>): stringRestore generated static diagram blocks from placeholders.mermaidMermaid Plugin - Native Rust renderer via NAPI Renders mermaid code blocks to SVG using…transformMermaidStatic(html: string, _options?: MermaidOptions): Promise<string>Transforms mermaid code blocks in HTML to rendered SVG diagrams. Uses the native Rust N…const FALLBACK_NOT_FOUND_MARKDOWN = `--- title: ${FALLBACK_NOT_FOUND_TITLE} --- # ${FALLBACK_NOT_FOUND_TITLE} The page you requested does not exist. Use search or the navigation to find what you need. `Built-in Markdown used when the configured source file is missing.isNotFoundSourceFile(filePath: string, srcDir: string, options?: ResolvedNotFoundOptions): booleanTrue when filePath is the enabled not-found source.not-foundOpt-in custom 404 page helpers. Resolution and path rules live here. The Vite plugin wr…notFoundSearchDocumentId(source: string): stringSearch document id for a not-found source path.notFoundSearchExcludeIds(options?: ResolvedNotFoundOptions): string[]Search document ids that must not be indexed when the feature is on.resolveNotFoundOptions(value: boolean | NotFoundOptions | undefined): ResolvedNotFoundOptionsResolves ssg.notFound with defaults. false / omitted stays off. true enables 404.md → 4…resolveNotFoundOutputPath(outDir: string, output: string): stringAbsolute output path, confined to outDir.resolveNotFoundSourcePath(srcDir: string, source: string): stringAbsolute source path, confined to srcDir.og-viewerOG Viewer - Dev tool for previewing Open Graph metadata Accessible at /__og-viewer duri…ogpOGP Card Plugin - Link card embedding Transforms <OgCard> components into static link p…optional-deps.dAmbient module declarations for optional dependencies. These packages are dynamically i…BasePagePropsBase page props available for all pages.FrontmatterSchemaSchema for frontmatter type generation.generateFrontmatterTypes(samples: Record<string, unknown>[], interfaceName = "PageFrontmatter"): stringGenerates TypeScript interface from frontmatter samples.inferType(value: unknown): stringInfers TypeScript types from frontmatter values.NavGroupNavigation group.NavItemNavigation item.page-contextPage Context for Static HTML Generation Provides a way to access page props (frontmatte…PageProps<T extends Record<string, unknown> = Record<string, unknown>> = BasePageProps & { frontmatter: T & Record<string, unknown> }Extended page props with custom frontmatter.RenderContext<T extends Record<string, unknown> = Record<string, unknown>>Complete render context.SiteConfigSite-wide configuration available in context.useIsActive(path: string): booleanChecks if the given path is the current page.useNav(): NavGroup[]Gets the navigation groups.usePageProps< T extends Record<string, unknown> = Record<string, unknown>, >(): PageProps<T>Gets the current page props.useRenderContext< T extends Record<string, unknown> = Record<string, unknown>, >(): RenderContext<T>Gets the full render context.useSiteConfig(): SiteConfigGets the site configuration.HeadInputBuild-time page-head input. Unhead-shaped, no client runtime. Unknown keys such as twit…HeadValidationMode = false | "off" | "warn" | "strict"How invalid head descriptors are reported.renderHead(input: HeadInput): RenderedHeadResolve descriptors to escaped <head> markup. Build-time only.extractIslandInfo(html: string): Promise<IslandInfo[]>Extract island info without transforming HTML. Useful for analysis/bundling purposes.findComponentElement(children: Element["children"]): Element | nullFind the component element inside <Island>.generateHydrationScript(components: string[]): stringGenerate client-side hydration script. This is a minimal script that imports and initia…getAttribute(el: Element, name: string): string | undefinedGet element attribute value.getComponentName(el: Element): stringGet component name from child element.hasIslands(html: string): booleanCheck if HTML contains any Island components.parseIsland Parser Detects <Island> components in HTML and transforms them into hydration-re…parseProps(el: Element): Record<string, unknown>Parse JSX-style props from attributes.rehypeIslands(collectedIslands: IslandInfo[])Rehype plugin to transform Island components.resetIslandCounter(): voidReset island counter (for testing).transformIslands(html: string): Promise<ParseIslandsResult>Transform Island components in HTML. Converts: ``html <Island load="visible"> <Counter…decodeHtmlEntities(value: string): stringExpand the character references that show up in <meta> content. Metadata is markup, so…faviconUrl(html: string, pageUrl: string): string | undefinedThe site's own icon, never a third-party favicon lookup service. Routing every card thr…resolveMetaUrl(value: string, pageUrl: string): string | undefinedResolve a URL taken from page metadata against the page it came from. Open Graph lets a…escapeAttribute(value: string): stringEscapes a value for use in an HTML attribute.permalinksOpt-in permalink / slug routing and index frontmatter cascade. Resolution follows oxc…resolveCascadeOptions(value: boolean | CascadeOptions | undefined): ResolvedCascadeOptionsResolves cascade. false / omitted stays off. true / {} enables.ResolvedRoutePageA page after cascade and optional permalink / slug rewriting.resolvePageRoutes(input: { pages: readonly RoutePageInput[]; permalinks?: ResolvedPermalinksOptions | null; cascade?: ResolvedCascadeOptions | null; }): RouteResolveOutputApplies cascade (when on) then permalink / slug rewriting (when on). Collisions skip th…resolvePermalinksOptions(value: boolean | PermalinksOptions | undefined): ResolvedPermalinksOptionsResolves permalinks. false / omitted stays off. true / {} enables.RoutePageInputOne page considered for cascade and permalink resolution.RouteResolveOutputResolved pages plus collision / rejection errors.pmPackage Manager Tabs Plugin Transforms <pm>npm install …</pm> blocks into a tab group w…PmOptionsOptions for transformPm.transformPm(html: string, options?: PmOptions): Promise<string>Transform <pm> package-manager blocks in HTML into install tabs.provider-article-valuesValue shaping for provider article cards: reading and writing tag attributes, and narro…provider-disk-cacheA cross-build cache for provider card metadata. Open Graph cards have had one of these…ProviderCacheEntry<T>What one cache file holds. null data is a remembered miss.providerCacheFileName(key: string): stringA file name for a cache key. Hashed rather than escaped: a key carries a provider URL,…readProviderCache<T>(cacheDir: string | null, key: string, ttl: number, now: number): Promise<T | null | undefined>Reads a cached value. Returns undefined for "nothing usable here" and null for "this wa…writeProviderCache<T>(cacheDir: string | null, key: string, data: T | null, cachedAt: number): Promise<void>Writes a value, replacing any existing entry atomically.EmbedFailure = { kind: "unavailable"; status: number } | { kind: "missing"; status: number } | { kind: "fetch-failed"; reason: string } | { kind: "offline"; reason: string }Why a build-time embed lookup did not produce metadata. Every fetcher used to collapse…errorCode(error: Error): string | undefinedcause is where undici puts the syscall error; older runtimes use code.const OFFLINE_CODES = new Set([ "ENOTFOUND", "EAI_AGAIN", "ECONNREFUSED", "ENETUNREACH", "ENETDOWN", "EHOSTUNREACH", ])Node's fetch reports a missing network through cause.code.let offlineReported = falseAn offline build fails every lookup for the same reason, so it says so once. One line p…provider-failureWhy a build-time embed lookup did not produce metadata. Every fetcher used to collapse…classifyPublishState(frontmatter: Record<string, unknown>, options: ResolvedPublishStateOptions | undefined): { output: boolean; listed: boolean }Classifies one frontmatter object. Never throws.filterNavGroups<T extends NavGroupLike>(groups: T[], hidden: ReadonlySet<string>): T[]Drops nav items that resolve to hidden (unpublished or unlisted) pages.hiddenNavKeys(pages: readonly PublishStatePage[], listed: readonly PublishStatePage[]): Set<string>Keys used to match a page against generated nav items.PartitionedPages<T>Split pages into production output vs listing surfaces.partitionPublishedPages<T extends { frontmatter: Record<string, unknown> }>(pages: readonly T[], options: ResolvedPublishStateOptions | undefined): PartitionedPages<T>Splits pages into those that write HTML and those that appear in listings.publish-stateOpt-in draft / unlisted / scheduled page classification.PublishStatePageOne page considered for publish-state filtering.resolvePublishStateOptions(value: boolean | PublishStateOptions | undefined): ResolvedPublishStateOptionsResolves publishState with defaults. false / omitted stays off. true enables production…generatePwa(input: PwaRenderInput): PwaRenderResultBuilds manifest / service-worker bodies without writing files.injectPwaPageTags(html: string, input: { options?: ResolvedPwaOptions | null; base?: string }): stringInjects rel=manifest (and the service-worker register script when offline) into a theme…pwaOpt-in web app manifest and conservative service worker. The Vite plugin writes those f…PwaRenderInputInputs for rendering PWA file bodies.PwaRenderResultRendered PWA bodies, or a skip warning.resolvePwaOptions(value: boolean | PwaOptions | undefined): ResolvedPwaOptionsResolves pwa with defaults. false / omitted stays off. true enables the manifest and of…writePwaFiles(input: WritePwaFilesInput): Promise<{ files: string[]; warning?: string }>Writes enabled PWA files into outDir.WritePwaFilesInput extends PwaRenderInputInputs for writing PWA files next to generated HTML.ReaderChromeOptionsPer-control flags for ssg.readerChrome. Omitted fields stay on when the feature itself…ResolvedReaderChrome = false | { copy: boolean; externalLinks: boolean; backToTop: boolean }Resolved reader chrome. false means no extra markup or JS.applyReaderChromeHtml(html: string, input: ReaderChromeInput = true): stringApply the same native reader-chrome HTML transform used by the built-in SSG. This rewri…readerChromeAttributes(input: ReaderChromeInput = true): Readonly<Record<string, "">>Root attributes consumed by the browser runtime.readerChromeCss(input: ReaderChromeInput = true): stringCSS shared by the built-in SSG and custom hosts.readerChromeScript(input: ReaderChromeInput = true): stringAuto-initializing script shared by the built-in SSG and custom hosts.renderReaderChromeAttributes(input: ReaderChromeInput = true): stringRender the root attributes as a leading-space HTML fragment. Useful in template strings…renderReaderChromeScriptTag(input: ReaderChromeInput = true): stringInline auto-init script for static hosts that do not bundle @ox-content/vite-plugin/rea…renderReaderChromeStyleTag(input: ReaderChromeInput = true): stringInline stylesheet tag for hosts that do not import @ox-content/vite-plugin/styles/reade…resolveReaderChromeInput(input: ReaderChromeInput = true): ResolvedReaderChromeResolve the public reader-chrome option shape. true mirrors ssg.readerChrome: true: cop…resolveRedirectProvider(explicit: RedirectProvider | undefined, env: NodeJS.ProcessEnv): { provider?: RedirectProvider; warning?: string }Resolves the _redirects host from an explicit option or CI env. Pass env so tests can i…generateRedirectHtml(dest: string): stringStatic HTML redirect body. dest is escaped.isHostWildcardSource(from: string): boolean* is host-rule syntax (Netlify / Cloudflare), not a URL segment.isSafeDest(value: string): booleanSame-origin path: leading /, not //, and no scheme.normalizePath(value: string): string | nullStrips a trailing slash except for /. Unsafe values become null.planRedirectFiles(input: RedirectPlanInput): RedirectPlanPlans redirect HTML files without writing them.RedirectFilePlanOne planned static HTML redirect.RedirectPageInputOne page that may declare aliases or a single redirect source.RedirectPlanPlanned redirect files and optional host / JSON bodies.RedirectPlanInputInputs for planning redirect files.redirectsOpt-in static redirects / aliases. HTML bodies follow oxcontentssg::generate_redirect…resolveRedirectsOptions(value: boolean | RedirectsOptions | Record<string, string> | undefined, env: NodeJS.ProcessEnv = process.env): ResolvedRedirectsOptionsResolves redirects with defaults. false / omitted stays off. true or {} enables empty d…writeRedirectFiles(input: WriteRedirectFilesInput): Promise<{ files: string[] }>Writes planned redirect HTML (and optional host files) into outDir.WriteRedirectFilesInputInputs for writing redirect files next to generated HTML.createMarkdownProcessor(options: OxContentOptions = {}): MarkdownProcessorResolves public options once so custom ssg: false hosts can reuse the pipeline.MarkdownProcessorProcessor that resolves OxContentOptions once and renders many documents.render-markdownProgrammatic Markdown/MDX pipeline for hosts that do not import files through Vite.renderMarkdown(source: string, filePath: string, options: OxContentOptions = {}): Promise<TransformResult>Run the Vite plugin Markdown/MDX pipeline from public OxContentOptions. Returns structu…rendererHTML → PNG renderer using Chromium screenshots via Playwright.renderHtmlToPng(page: Page, html: string, width: number, height: number, publicDir?: string): Promise<Buffer>Renders an HTML string to a PNG buffer using Chromium.routePublicDir(page: Page, publicDir: string): Promise<void>Serves local assets from publicDir for anything the card requests. Registered once per…wrapHtml(bodyHtml: string, width: number, height: number, useBaseUrl: boolean): stringWraps template HTML in a minimal document with viewport locked to given dimensions.createGitHubCard(repoData: GitHubRepoData): ElementCreate GitHub card element from repo data.resolveOptions(options: OxContentOptions): ResolvedOptionsResolves plugin options with defaults.hashResourceFile(filePath: string, ext: string, store: ResourceDedupeStore, reuseKey: string): Promise<string>SHA-256 of emitted bytes plus a NUL and the serving extension so the same payload canno…linkOrCopyAlias(canonical: string, alias: string, linker: typeof fs.link = fs.link): Promise<"link" | "copy">Prefer a hard link at the original output path. link failure removes any stale alias an…resources-dedupeSite-wide content-addressed emit for identical page-resource bytes. Hashing streams the…rewriteToCanonicalUrl(originalSrc: string, canonicalPath: string): stringKeep leftover search/hash; drop consumed transform params.const RESOURCE_TAG = /<(?:img|video|audio|source|track|a)\b[^>]*>/giCollect local src, poster, and relevant href values from HTML tags.resources-htmlCollect local src, poster, and relevant href values from HTML tags.resources-imageBuild-time PNG/JPEG pixel helpers for page resources. PNG is decoded and re-encoded for…resources-jpegJPEG encode-only helpers for page resource transforms.resources-processPage-resource HTML rewriting and transform writes.resources-writeTransform cache writes for page resources.isInsideRoot(root: string, candidate: string): booleanTrue when candidate stays inside root after resolve.resolveResourcesOptions(value: boolean | ResourcesOptions | undefined): ResolvedResourcesOptionsResolves resources. Omitted / false stay off. true or {} enables defaults. An object en…resourceCacheKey(sourcePath: string, mtimeMs: number, transform: ResourceTransform): stringCache key for a source file plus transform. Changing mtime or params produces a differe…resourcesOpt-in page-bundle resources and build-time image processing. A page directory is the b…renderHtmlToPngWithSatori(source: string, options: ResolvedOgImageOptions, root: string): Promise<Buffer>Render an HTML string to PNG using Satori and resvg.search-filtersLanguage and version filters for the default search dialog.searchDocumentLocale(path: string, localeCodes: readonly string[], defaultLocale: string, versionPrefixes: readonly string[] = []): stringResolves a document path to a locale code after stripping version prefixes.generateHostedSearchModule(options: ResolvedSearchOptions): stringClient runtime that queries the hosted HTTP adapter. Misconfigured hosted search emits…hasForbiddenSearchCredentialFields(options: object): booleanReturns true when the options object names a write or admin credential.resolveHostedSearchConfig(options: SearchOptions, env: NodeJS.ProcessEnv = process.env): HostedSearchConfig | nullResolves hosted credentials from config or env. Missing or forbidden keys fail closed a…search-providerOpt-in hosted search provider for virtual:ox-content/search. Local BM25 stays the defau…toLocalSearchRuntimeOptions(options: ResolvedSearchOptions)Runtime fields accepted by the native local BM25 module generator.buildSearchIndex(srcDir: string, base: string, extensions: readonly string[] = DEFAULT_MARKDOWN_EXTENSIONS, publishState?: ResolvedPublishStateOptions, excludeDocumentIds: readonly string[] = [], mdx?: boolean, conditionalBlocks?: ResolvedConditionalBlockOptions, citations?: ResolvedCitationsOptions): Promise<string>Builds the search index from Markdown files. publishState is forwarded to the native in…generateSearchModule(options: ResolvedSearchOptions, indexPath: string): stringClient-side search module code. This is injected into the bundle as a virtual module.getSearchDocumentScopes(doc: Pick<SearchDocument, "id" | "url">): string[]Derives hierarchical search scopes from a document id or URL. For example, api/math/ind…matchesSearchScopes(doc: Pick<SearchDocument, "id" | "url">, scopes: string[]): booleanReturns true when a search document belongs to at least one requested scope.parseScopedSearchQuery(query: string): ScopedSearchQuerySplits a raw query into free-text terms and @scope prefixes.resolveSearchOptions(options: SearchOptions | boolean | undefined): ResolvedSearchOptionsResolves search options with defaults.searchFull-text search functionality for Ox Content. Generates search index at build time and…writeSearchIndex(indexJson: string, outDir: string): Promise<void>Writes the search index to a file.escapeSectionIndexHtml(value: string): stringEscapes text and attribute values in generated listing markup.isSafeSectionHref(value: string): booleanhttps:-free, same-origin or relative href. javascript: is rejected.renderSectionIndexHtml(title: string, items: readonly SectionIndexItem[], style: SectionIndexStyle): stringRenders the listing body. Titles are escaped; hostile hrefs are dropped.section-index-htmlSection-index listing HTML and href safety. Titles are escaped. javascript: / data: / v…SectionIndexItemOne child link on a generated section index.section-index-pathsSection-index URL, title, and output-path helpers.appendSectionIndexPages(input: { generatedPages: Array<{ inputPath: string; outputPath: string; html: string }>; collectedPages: readonly SectionIndexSourcePage[]; listedPages: readonly SectionIndexSourcePage[]; options?: ResolvedSectionIndexOptions; outDir: string; base: string; extension: string; errors: string[]; render: (page: SectionIndexGeneratedPage) => Promise<string>; }): Promise<void>Appends generated section indexes for directories that have no real index.resolveSectionIndexOptions(value: boolean | SectionIndexOptions | undefined): ResolvedSectionIndexOptionsResolves ssg.sectionIndex with defaults. false / omitted stays off. true enables card l…section-indexOpt-in generated section index pages. Resolution and directory walking live here. Listi…SectionIndexGeneratedPageSynthetic page passed back to generateHtmlPage.SectionIndexSourcePageOne built page considered when deciding indexes and children.toSectionIndexProcessResult(page: SectionIndexGeneratedPage): { inputPath: string; routePaths: { outputPath: string; urlPath: string; href: string; ogImagePath: string; ogImageUrl: string; }; transformedHtml: string; title: string; frontmatter: Record<string, unknown>; toc: []; }Maps a generated section index onto the SSG render shape.formatLastmod(timestampMs: number | undefined): string | undefinedUTC YYYY-MM-DD for W3C lastmod. Invalid or negative timestamps are dropped.generateSiteMaps(input: SiteMapsRenderInput): SiteMapsRenderResultBuilds sitemap / robots / llms bodies without writing files.resolveSiteMapsOptions(value: boolean | SiteMapsOptions | undefined): ResolvedSiteMapsOptionsResolves siteMaps with defaults. false / omitted stays off. true enables all three file…site-mapsOpt-in sitemap.xml / robots.txt / llms.txt helpers. Bodies come from oxcontentssg::ge…SiteMapPageInputOne page considered for crawl manifests.SiteMapsRenderInputInputs for rendering crawl-manifest bodies.SiteMapsRenderResultRendered crawl-manifest bodies, or a skip warning.writeSiteMapFiles(input: WriteSiteMapFilesInput): Promise<{ files: string[]; warning?: string }>Writes enabled crawl manifests into outDir.WriteSiteMapFilesInputInputs for writing crawl manifests next to generated HTML.resolveGitLastmod(filePath: string, root?: string): number | undefinedGit last-commit time for filePath in milliseconds. Same lookup buildSsg() uses for ssg.…ssg-output-writeWriters for composable SSG outputs. Custom hosts call these without buildSsg().writeMarkdownCompanions(input: WriteMarkdownSourceFilesInput): Promise<{ files: string[]; errors: string[] }>Write Markdown companions for host-rendered pages. Reuses writeMarkdownSourceFiles from…writeResourceFiles(input: WriteResourceFilesInput): Promise<WriteResourceFilesResult>Fingerprint, rewrite, and emit page resources for host-rendered HTML. Uses the same res…WriteResourceFilesInputInputs for writing fingerprinted page resources from host HTML.WriteResourceFilesPageOne host-rendered page that may receive resource fingerprinting.WriteResourceFilesResultRewritten host pages plus emitted resource paths.planSsgOutputs(input: PlanSsgOutputsInput): SsgOutputPlanPlan resource, companion, feed, and sitemap outputs without rendering pages. ssg.enable…PlanSsgOutputsInputInputs for planning composable SSG outputs from host-rendered pages.PlanSsgOutputsOptionsSame option objects oxContent() / buildSsg() accept. ssg.enabled is ignored.ssg-outputComposable SSG outputs for custom hosts that set ssg: false. Ox Content owns resource f…SsgOutputPlanPlanned writer inputs. Call the matching write* function for each feature.buildNavItems(markdownFiles: string[], srcDir: string, base: string, extension: string): NavGroup[]Builds navigation items from markdown files, grouped by directory.buildSsg(options: ResolvedOptions, root: string): Promise<SsgBuildResult>Builds all markdown files to static HTML.buildThemeNavItems(sidebar: SidebarItem[], base: string, extension: string): NavGroup[]Builds navigation items from an explicit theme sidebar tree while retaining locale-map…canonicalPageUrl(context: BuildSsgContext, urlPath: string): string | undefinedAbsolute URL of a page, or undefined when ssg.siteUrl is not set. Built the same way ge…collectMarkdownFiles(srcDir: string, extensions: readonly string[] = DEFAULT_MARKDOWN_EXTENSIONS): Promise<string[]>Collects all markdown files from the source directory.const DEFAULT_HTML_TEMPLATE = "<!-- ox-content default HTML template is Rust-backed -->"Deprecated compatibility export for consumers that imported the former TypeScript SSG t…extractTitle(content: string, frontmatter: Record<string, unknown>): stringExtracts title from content or frontmatter.formatTitle(name: string): stringFormats a file/dir name as a title.generateBareHtmlPage(content: string, title: string): stringGenerates bare HTML page (no navigation, no styles).generateBarePage(page: SsgBarePage): stringGenerates a bare HTML page carrying head metadata and injected markup. Bare mode leaves…getHref(inputPath: string, srcDir: string, base: string, extension: string, routePrefix?: string): stringConverts a markdown file path to an href.getOutputPath(inputPath: string, srcDir: string, outDir: string, extension: string, routePrefix?: string): stringConverts a markdown file path to its corresponding HTML output path.getUrlPath(inputPath: string, srcDir: string, routePrefix?: string): stringConverts a markdown file path to a relative URL path.const localeCodesCache = new WeakMap<LocaleConfig[], string[]>()Per-build cache for the locale-code list passed to getSsgPageLocale. The i18n.locales r…NavGroupNavigation group for hierarchical navigation.const navGroupsForRustCache = new WeakMap<NavGroup[], RustNavGroup[]>()Per-build cache for the Rust-facing nav conversion. navGroups is the same context.navIt…normalizeRoutePrefix(value?: string): string | undefinedNormalizes blog / /blog / /blog/ to blog. Empty or unsafe values stay off.parseSsgPagerOverride(value: unknown): SsgPagerOverride | undefinedParses prev / next frontmatter into a pager override.resolveNavigationGroups(navigation: SsgNavigationGroup[] | undefined, base: string, extension: string): NavGroup[] | undefinedResolves manual navigation config to the format used by the built-in SSG renderer.resolveSsgOptions(ssg: SsgOptions | boolean | undefined): ResolvedSsgOptionsResolves SSG options with defaults.RustLocaleRust-facing locale shape.const rustLocalesCache = new WeakMap<LocaleConfig[], RustLocale[]>()Per-build cache for the Rust-facing locale list. i18n.locales is the same reference for…RustNavGroupNAPI-facing nav group shape produced from a NavGroup.shouldGenerateOgImages(options: ResolvedOptions): booleanWhether this build emits one Open Graph image per page. ssg.bare deliberately does not…sitePathFromUrlPath(urlPath: string): stringTurns an SSG urlPath (guide or /) into a same-origin dest (/guide).ssgSSG (Static Site Generation) module for ox-contentSsgBarePageHead metadata and injected markup for a bare page.SsgBuildResultResult of an SSG build.SsgEntryPageConfigEntry page configuration for SSG (passed to Rust).SsgNavItemNavigation item for SSG.SsgPageDataPage data for SSG.SsgPagerOverrideFrontmatter override for one previous/next pager side.toRustTocEntry(entry: TocEntry): TocEntryConverts a TocEntry tree into the plain shape the Rust binding expects. Hoisted to modu…toThemePageData(pageResult: PageProcessResult, markdownSource?: string): ThemePageDataMaps an internal page result onto the theme renderer's page shape.generateTabsCSS(groupCount: number): stringGenerate dynamic CSS for :has() based tab switching. This is needed because :has() sele…getTabGroupCounter(): numberRead the shared tab group counter. Other tab-like transforms (such as the package-manag…resetTabGroupCounter(): voidReset tab group counter (for testing and per dev-server request).setTabGroupCounter(value: number): voidSet the shared tab group counter (advanced by other tab-like transforms).tabsTabs Plugin - Pure CSS implementation Transforms <Tabs>/<Tab> components into accessibl…transformTabs(html: string): Promise<string>Transform Tabs components in HTML.taxonomies-htmlEscaped taxonomy HTML and confined output paths.TaxonomySourcePageOne built page considered for terms and related lists.appendTaxonomyPages(input: { generatedPages: Array<{ inputPath: string; outputPath: string; html: string }>; listedPages: readonly TaxonomySourcePage[]; options?: ResolvedTaxonomiesOptions; outDir: string; base: string; render: (page: TaxonomyGeneratedPage) => Promise<string>; errors: string[]; }): Promise<void>Renders themed list and per-term pages and appends them to the build.injectRelatedPages(pages: TaxonomySourcePage[], listed: readonly TaxonomySourcePage[], options?: ResolvedTaxonomiesOptions): voidAppends related-page HTML to source pages that share a listed term.resolveTaxonomiesOptions(value: boolean | TaxonomiesOptions | undefined): ResolvedTaxonomiesOptionsResolves taxonomies with defaults. false / omitted stays off. true enables tags and cat…taxonomiesOpt-in taxonomy term pages and related-page lists. Resolution and HTML live here. The V…TaxonomyGeneratedPageSynthetic page passed back to generateHtmlPage.termSlug(term: string): string | undefinedStable URL slug for a frontmatter term. Returns undefined when the value cannot become…toTaxonomyProcessResult(page: TaxonomyGeneratedPage): { inputPath: string; routePaths: { outputPath: string; urlPath: string; href: string; ogImagePath: string; ogImageUrl: string; }; transformedHtml: string; title: string; frontmatter: Record<string, unknown>; toc: []; }Maps a generated taxonomy page onto the SSG render shape.resolveTeamOptions(value: boolean | TeamOptions | undefined): ResolvedTeamOptionsResolves ssg.team with defaults. false / omitted stays off. true enables an empty membe…teamOpt-in team / members page helpers. Resolution lives here. Member cards are rendered in…escapeHtml(str: string): stringEscapes HTML special characters.getDefaultSatoriTemplate(): OgImageTemplateFnReturns the built-in template for the Satori renderer. The Chromium template intentiona…getDefaultTemplate(): OgImageTemplateFnReturns the built-in default template function.templateDefault OG image template. Uses inline HTML/CSS for a flat, low-color brand card with t…applyThemeBootstrap(options: ThemeBootstrapOptions = {}): ThemeBootstrapStateApply the resolved theme state to the configured root element. Hosts can reuse this ins…createThemeBootstrapScript(options: ThemeBootstrapOptions = {}): stringReturn the exact inline JavaScript body a static host can hash for CSP.renderThemeBootstrapScript(options: ThemeBootstrapOptions = {}, renderOptions: RenderThemeBootstrapScriptOptions = {}): stringRender an inline first-paint bootstrap tag. Use createThemeBootstrapScript() when a dep…resolveThemeBootstrapState(storedPreference: string | null | undefined, prefersDark: boolean, options: ThemeBootstrapOptions = {}): ThemeBootstrapStateResolve a stored theme preference to the root state the bootstrap applies.setThemeBootstrapPreference(preference: ThemeBootstrapPreference, options: ThemeBootstrapOptions = {}): ThemeBootstrapStatePersist a preference and apply it with the same root contract as the bootstrap.theme-fonts-acquireResolve self-hosted faces from a local file / @fontsource directory or Google Fonts. Do…cssFamilyName(family: string): stringCSS font-family identifier; quotes names that are not a single ident.flattenThemeFonts(fonts: ThemeFontsLike): { sans?: string; mono?: string } | undefinedFlatten object fonts so JsThemeFonts stays { sans?: string; mono?: string }.namedFontVarsCss(fonts: ThemeFontsLike): stringExtra --octc-font-* variables for fonts.named. Roles stay in Rust theme CSS.theme-fontsOpt-in web-font objects for theme.fonts, plus SSG self-host emission. NAPI still receiv…ThemeWebFontUnoCSS-inspired family descriptor. The string stack form remains valid.writeSelfHostedThemeFonts(options: WriteThemeFontsOptions): Promise<string[]>Copy self-hosted faces into outDir and write @font-face CSS.createTheme(config: { layouts: Record<string, ThemeComponent>; defaultLayout?: string; }): ThemeComponentCreates a theme with layout switching support.DefaultTheme({ children }: ThemeProps): JSXNodeDefault theme component. A minimal theme that renders page content with basic styling.generateTypes(pages: PageData[], outDir: string): Promise<void>Generates TypeScript type definitions from page frontmatter.PageDataPage data for rendering.renderAllPages(pages: PageData[], options: ThemeRenderOptions): Promise<Map<string, string>>Renders all pages and generates type definitions.renderPage(page: PageData, options: ThemeRenderOptions): stringRenders a page using the theme component.theme-rendererTheme Renderer for Static HTML Generation Renders JSX theme components to static HTML s…ThemeComponent = (props: ThemeProps) => JSXNodeTheme component type.ThemePropsProps passed to the theme component.ThemeRenderOptionsTheme render options.expandExtendsChain(theme: ThemeTokenSource): ThemeTokenSource[]Flattens one layer's extends chain into base-first order, mirroring the SSG's own resol…renderThemeTokenCss(theme: ThemeTokenSource | ThemeTokenSource[], options: RenderThemeTokenCssOptions = {}): stringRenders a theme's --octc-* tokens as a standalone stylesheet. The built-in SSG emits th…RenderThemeTokenCssOptionsOptions for renderThemeTokenCss.ThemeTokens = Record<string, string>Free-form --octc-* custom properties for themes that need more than the typed colors /…ThemeTokenSourceThe token-bearing shape of a theme. Declared structurally instead of importing ThemeCon…tokensToCss(light: ThemeTokens, dark: ThemeTokens): stringRenders light and dark token records as the three selectors the SSG runtime switches be…deepMerge<T extends Record<string, unknown>>(target: T, source: Partial<T>): TDeep merge two objects.const defaultTheme: ThemeConfigDefault theme configuration. Based on the current ox-content SSG styles.defineTheme(config: ThemeConfig): ThemeConfigDefines a theme configuration with type checking.expandExtendsChain(config: ThemeConfig): ThemeConfig[]Flattens one layer's extends chain into base-first order. The seen guard keeps a theme…LegacySocialLinksLegacy social links configuration.mergeThemes(...themes: (ThemeConfig | ThemeConfig[])[]): ThemeConfigMerges multiple theme configurations. Later themes override earlier ones. Object fields…NapiSocialLinksNAPI-compatible social links type.NapiThemeColorsNAPI-compatible theme colors type.NapiThemeConfigNAPI-compatible theme configuration type.NapiThemeEmbedNAPI-compatible theme embed type.NapiThemeEntryPageNAPI-compatible entry page theme type.NapiThemeFontsNAPI-compatible theme fonts type.NapiThemeFooterNAPI-compatible theme footer type.NapiThemeHeaderNAPI-compatible theme header type.NapiThemeLayoutNAPI-compatible theme layout type.ResolvedThemeConfigResolved theme configuration (after merging with defaults).resolveTheme(config?: ThemeConfig | ThemeConfig[]): ResolvedThemeConfigResolves a theme configuration by merging with its extends chain and defaults. An array…SidebarItemSidebar group or link, including recursively nested localized labels.SocialLinkCustom social link.SocialLinkIcon = string | { svg: string }Custom social link icon.SocialLinks = LegacySocialLinks | SocialLink[]Social links configuration.themeTheme API for ox-content SSG Provides VitePress-like theming with default theme + custo…ThemeColorsTheme color configuration.ThemeConfigComplete theme configuration.themeCss(theme: ResolvedThemeConfig): stringToken blocks come first so a theme's own css stays the final word, and both land after…ThemeEmbedEmbedded HTML content for specific positions in the page layout.ThemeEntryPageEntry page theme configuration.ThemeFontsTheme font configuration. sans and mono accept a CSS stack string or a web-font object.…ThemeFooterTheme footer configuration.ThemeHeaderTheme header configuration.ThemeLayoutTheme layout configuration.themeToNapi(theme: ResolvedThemeConfig, locale?: string, base?: string, iconsEnabled = false): NapiThemeConfigConverts resolved theme to the format expected by Rust NAPI.transformGitHub(html: string, repoDataMap?: Map<string, GitHubRepoData | null>, options?: GitHubOptions): Promise<string>Transform GitHub components in HTML.extractImports(content: string): string[]Extracts imports from Markdown content. Supports importing components for interactive i…generateModuleCode(html: string, frontmatter: Record<string, unknown>, toc: TocEntry[], imports: MdxImport[], exports: string[], components: string[], crossReferences: CrossReferenceEntry[], citations: CitationReference[], bibliography: BibliographyEntry[], filePath: string): stringGenerates the JavaScript module code. MDX metadata is serialized as JSON. User import /…generateOgImageSvg(data: OgImageData, config?: OgImageConfig): Promise<string | null>Generates an OG image SVG using the Rust-based generator. This function uses the Rust N…JsTransformOptionsOptions for Rust-based Markdown transformation. Controls which Markdown extensions and…NapiTransformResultWhat the native transform entry points return.OgImageConfigOG image configuration.OgImageDataOG image data for generating social media preview images.runTransformers(napi: NapiBindings, markdown: string, napiOptions: JsTransformOptions, filePath: string, options: ResolvedOptions, transformers: readonly MarkdownTransformer[]): Promise<NapiTransformResult>Runs the configured transformers over the parsed tree. Markdown never passes through Vi…SsgTransformOptionsSSG-specific transform options.transformMarkdown Transformation Engine This module handles the complete transformation pipeline…const UNHIGHLIGHTED_CODE_BLOCK = /<pre(?![^>]*ox-highlight)[^>]*><code class="language-/A <pre> that names a language but has not been highlighted yet.warnMathFailures(failures: MathRenderFailure[], filePath: string): voidReports every $…$ run KaTeX refused. Under the default policy the page keeps its prose,…OgImageOptionsOG image generation options (user-facing).OgImageRenderer = "chromium" | "satori"OG image rendering backend.OgImageSatoriFontFont file loaded by the Satori renderer.OgImageSatoriFontWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900Font weight values supported by Satori.OgImageSatoriOptionsSatori renderer options.OgImageTemplateFn = (props: OgImageTemplateProps) => string | Promise<string>Template function that receives page metadata and returns an HTML string.OgImageTemplatePropsProps passed to OG image template functions.ResolvedOgImageOptionsResolved OG image options with all defaults applied.typesType definitions for OG image generation.TweetBodyDataRoot or quoted post body. Nested quoted_tweet is stripped during normalize.A11yOptionsPer-control flags for ssg.a11y. Omitted fields keep the defaults when the feature itsel…AbbreviationsOptionsOptions for opt-in abbreviation and glossary expansion.AttrsOptionsOptions for markdown-it-attrs style attribute blocks. Attribute blocks let authors atta…BadgeOptionsOptions for opt-in {badge:variant} inline badges.BlogAuthorOne person in the blog.authors map.BlogFeedFailurePolicy = "warn" | "error"How a failed external feed source is reported.BlogFeedSourceOne configured external blog feed.BlogOptionsOpt-in blog index, authors, tags, reading time, and archive.BuiltinEmbedOptionsBuilt-in embed configuration.BuiltinPmOptionsOptions for the package-manager install-tab transform.CardOptionsOptions for opt-in ::: card / ::: link-card / ::: card-grid blocks.CascadeOptionsOpt-in _index directory frontmatter cascade. false or omitted stays off. true or {} ena…CodeAnnotationKind = "highlight" | "warning" | "error"Supported line annotation kinds for code blocks.CodeAnnotationsOptionsOpt-in code annotation configuration.CodeAnnotationSyntax = "attribute" | "vitepress" | "both"Supported code annotation syntaxes.CodeBlockLintOptionsOptions for linting fenced code blocks during Markdown transforms. These checks are int…CodeBlockTypecheckOptionsOptions for type-checking TypeScript and TSX fenced code blocks. Type-checking writes m…CodeGroupOptionsOptions for opt-in ::: code-group fence groups.CodeImportOptionsOptions for importing source snippets into code fences. The transform resolves <<< impo…CollectionEntryQueryable Markdown collection entry.CollectionIncludeField = "body" | "html" | "toc"Extra payload fields embedded into collection entries. Keep this list small for large s…CollectionManifestGenerated collection manifest.CollectionOptionsCollection source configuration.CollectionsOptions = Record<string, CollectionOptions | string | readonly string[]>Top-level collection definitions.ConditionalBlockOptionsOptions for opt-in static conditional blocks.ContainerOptionsOptions for opt-in ::: type custom containers.ContainerTypeOptionsPer-type container presentation.ContributorsOptionsOpt-in git contributor list.DataTableOptionsOptions for opt-in csv-table / json-table fences.DefinitionListOptionsOptions for opt-in PHP Markdown Extra / mdBook-style definition lists.DocEntryA single documentation entry extracted from source. Entries represent top-level declara…DocMemberA member belonging to a class, interface, type alias, or enum entry.DocsEntryPoint = string | { path: string; name?: string }Public API entry point for grouped documentation.DocsNavigationItemNavigation item emitted for generated docs sidebars.DocsOptionsOptions for source documentation generation. The generator extracts JSDoc/TSDoc comment…DocsSummarySummary counts emitted with generated documentation data.DocsTestOptionsOptions for extracting fenced examples into docs-as-tests fixtures. The extractor colle…EditThisPageOptionsOptions for appending an "edit this page" link. The generated link points at the source…EditThisPageProvider = "github" | "gitlab" | "bitbucket" | "gitea"Forges with a known edit-URL shape. 'gitea' covers Forgejo, which kept the same path.EmojiShortcodeOptionsOptions for expanding :shortcode: emoji aliases. The transform replaces recognized shor…EntryPageConfigEntry page frontmatter configuration.ExtractedDocsExtracted documentation for a single file.FeatureConfigFeature card for entry page.FeedChannelOptionsOne feed's formats, source, output path, and channel metadata.FeedFormat = "rss" | "atom" | "json"Feed file formats written during SSG.FeedItemAttachmentOne JSON Feed / enclosure attachment accepted by programmatic feeds.FeedItemAuthorOne feed item author accepted by programmatic feeds.FeedItemInputOne collection or programmatic item considered for a generated feed.FeedsOptions = FeedChannelOptions | readonly FeedChannelOptions[] | { [name: string]: FeedChannelOptions }Opt-in RSS / Atom / JSON Feed files written during SSG. A single object is one default…FileTreeIconOptionsReplaceable file-tree icons. Values are trusted site-config SVG markup or CSS class tok…FileTreeOptionsOptions for opt-in file-tree fences.GeneratedDocsDataMachine-readable payload emitted alongside generated docs.GeneratedOpenApiDocsGenerated OpenAPI Markdown pages and sidebar metadata.HeadingPermalinksOptionsOpt-in visible heading permalinks. Headings already have stable ids. Enabling this appe…HeroActionHero section action button.HeroConfigHero section configuration for entry page.HeroImageHero section image configuration.HeroNoticeHero notice configuration.I18nOptionsi18n (internationalization) options. i18n is opt-in because it changes routing and buil…IconsOptionsOpt-in self-hosted Iconify CSS for used icons. Off by default. When enabled, the SSG bu…ImageGalleryOptionsOptions for opt-in static image galleries.ImageOptionsOptions for opt-in figures, captions, and lazy images.IncludeOptionsOptions for inlining Markdown files with <!-- @include: PATH -->. Relative paths resolv…JsonLdOptionsPer-control flags for ssg.jsonLd. Omitted fields keep the defaults when the feature its…JsonLdPageType = "TechArticle" | "BlogPosting" | "WebPage"JSON-LD page node @type. Unknown values fall back to TechArticle.JsonLdPublisherOptionsOptional JSON-LD publisher. Empty or omitted fields are left out.KatexFontFormats = "woff2" | "all"Which of KaTeX's font formats to emit.KeyboardKeysOptionsOptions for opt-in {kbd:...} inline keyboard keys.LocaleConfigLocale configuration. Locales define the routing and display metadata used by the i18n…MagicLinkAliasOne configured magic-link target.MagicLinkImageOverrideReplace the image for an exact href or prefix.MagicLinkOptionsOptions for opt-in {link:...} rich magic links.MarkdownNodeMarkdown AST node (simplified for TypeScript).MarkdownSourceOptionsOpt-in Markdown source companions written beside generated HTML.MarkdownTransformerCustom AST transformer.MathErrorPolicy = "literal" | "error" | "render"What to do with a $…$ run KaTeX cannot parse.MathOptionsOptions for opt-in $…$ / $$…$$ math. Delimiter parsing lives in the native transform. T…MdxImportOne MDX import statement collected from the AST.MdxImportSpecifierOne binding created by an MDX import statement.MdxImportSpecifierKind = "default" | "named" | "namespace"How a specifier was imported from an MDX import statement.NavItemNavigation item for sidebar navigation.NotByAiOptionsOptions for the opt-in <NotByAI /> authorship badge.NotFoundOptionsOpt-in custom 404 page written during SSG.OgImageOptionsOG image generation options. Uses Chromium or Satori rendering with customizable templa…OgImageRenderer = "chromium" | "satori"OG image rendering backend.OgImageSatoriFontFont file loaded by the Satori renderer.OgImageSatoriFontWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900Font weight values supported by Satori.OgImageSatoriOptionsSatori renderer options.OpenApiDocsInputOne local OpenAPI file consumed by generated REST API docs.OpenApiDocsOptionsObject form for configuring generated OpenAPI docs.OpenApiDocsSource = string | OpenApiDocsInputOpenAPI docs shorthand accepted by docs.openapi.OxContentOptionsOptions for the core oxContent() Vite plugin. The top-level options describe where cont…ParamDocParameter documentation.PartialsOptionsOptions for parameterized Markdown partials with <!-- @partial: PATH k="v" -->. Bare na…PermalinksOptionsOpt-in frontmatter permalink / slug routing. false or omitted stays off. true or {} ena…PublishStateOptionsOpt-in draft / unlisted / scheduled page filtering.PwaOptionsOpt-in web app manifest and service worker written during SSG. Enabling offline (the de…RedirectProvider = "netlify" | "cloudflare"Host that consumes the generated redirects file. Both values write the same redirects…RedirectsOptionsOpt-in static redirects, aliases, and path rewrites. A path map such as { "/old-guide":…ResolvedA11y = false | { skipLinkLabel: string }Resolved skip-link / print styles. false means no extra markup or CSS.ResolvedAbbreviationsOptionsResolved abbreviation / glossary transform options.ResolvedAttrsOptionsResolved attrs transform options.ResolvedBadgeOptionsResolved inline-badge transform options.ResolvedBlogFeedSourceResolved external blog feed source.ResolvedBlogOptionsResolved blog options.ResolvedBuiltinEmbedOptionsResolved built-in embed configuration.ResolvedCardOptionsResolved card transform options.ResolvedCascadeOptionsResolved cascade options.ResolvedCodeAnnotationsOptionsResolved code annotation configuration.ResolvedCodeBlockLintOptionsResolved code-block lint options.ResolvedCodeBlockTypecheckOptionsResolved code-block type-check options.ResolvedCodeGroupOptionsResolved code-group transform options.ResolvedCodeImportOptionsResolved code-import transform options.ResolvedCollectionOptionsResolved collection definition.ResolvedCollectionsOptionsResolved collection options.ResolvedConditionalBlockOptionsResolved conditional-block transform options.ResolvedContainerOptionsResolved custom-container transform options.ResolvedContributors = false | { ignore: string[]; avatars: boolean }Resolved git contributor list. false means the feature is off.ResolvedDataTableOptionsResolved data-table transform options.ResolvedDefinitionListOptionsResolved definition-list transform options.ResolvedDocsEntryPointResolved public API entry point.ResolvedDocsOptionsResolved docs options with all defaults applied.ResolvedDocsTestOptionsResolved docs-as-tests extraction options.ResolvedEditThisPageOptionsResolved edit-link transform options.ResolvedEmojiShortcodeOptionsResolved emoji-shortcode transform options.ResolvedFeedChannelOne resolved feed channel.ResolvedFeedsOptions extends ResolvedFeedChannelResolved feed options. Legacy true / single-object configs keep one channel on the top-…ResolvedFileTreeOptionsResolved file-tree transform options.ResolvedHeadingPermalinksOptionsResolved heading permalink options.ResolvedI18nOptionsResolved i18n options with all defaults applied.ResolvedIconsOptionsResolved icon asset options.ResolvedImageGalleryOptionsResolved image gallery transform options.ResolvedImageOptionsResolved image transform options.ResolvedIncludeOptionsResolved Markdown-include transform options.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">.ResolvedKeyboardKeysOptionsResolved inline keyboard-key transform options.ResolvedMagicLinkOptionsResolved magic-link transform options.ResolvedMarkdownSourceOptionsResolved Markdown source-companion options.ResolvedMathOptionsResolved math transform options.ResolvedNotByAiOptionsResolved NotByAI authorship-badge options.ResolvedNotFoundOptionsResolved custom 404 options.ResolvedOgImageOptionsResolved OG image options with all defaults applied.ResolvedOpenApiDocsInputResolved local OpenAPI file input.ResolvedOpenApiDocsOptionsResolved generated OpenAPI docs options.ResolvedOptionsResolved options with all defaults applied.ResolvedPartialsOptionsResolved parameterized-partial transform options.ResolvedPermalinksOptionsResolved permalink options.ResolvedPublishStateOptionsResolved publish-state options.ResolvedPwaOptionsResolved PWA options.ResolvedRedirectsOptionsResolved redirect options.ResolvedResourcesOptionsResolved page-resource options.ResolvedSanitizeOptionsResolved sanitize transform options.ResolvedSearchOptionsResolved search options.ResolvedSectionIndexOptionsResolved generated section index options.ResolvedSiteMapsOptionsResolved crawl-manifest options.ResolvedSsgOptionsResolved SSG options.ResolvedStepsOptionsResolved step-list transform options.ResolvedTaxonomiesOptionsResolved taxonomy options.ResolvedTeamOptionsResolved team page options.ResolvedTimelineOptionsResolved timeline transform options.ResolvedTypedHoverOptionsResolved typed-hover options.ResolvedVersionEntryOne resolved version after prefix and banner sanitization.ResolvedVersionsOptionsResolved documentation versioning.ResolvedWikiLinkOptionsResolved wiki-link transform options.ResourcesOptionsOptions for opt-in page-bundle resources and image processing.ReturnDocReturn type documentation.SanitizeOptionsOptions for sanitizing rendered HTML. Sanitization happens after Markdown is rendered t…ScopedSearchQueryParsed search query with optional scope prefixes.SearchDocumentSearch document structure.SearchOptionsOptions for full-text search. Search indexes are built from Markdown content at build t…SearchResultSearch result structure.SectionIndexOptionsOpt-in generated section index pages.SectionIndexStyle = "list" | "cards"Listing style for a generated section index.SiteMapsOptionsOpt-in crawl manifests written during SSG.SsgNavigationGroupNavigation group for SSG sidebar rendering.SsgNavigationItemNavigation item for SSG sidebar rendering.SsgOptionsStatic Site Generation options. These options control the HTML files emitted at build t…SsgOutputPageInputOne host-owned page for composable SSG outputs (ssg: false). The host renders HTML. Ox…StepsOptionsOptions for opt-in ::: steps ordered lists.TaxonomiesOptionsOpt-in term list pages, per-term pages, and related-page lists.TeamLinkOne link on a team member card.TeamMemberOne person on the team page.ThrowsDocException/error documentation.TimelineOptionsOptions for opt-in static timelines.TocEntryTable of contents entry.TransformContextTransform context passed to transformers.TransformResultTransform result.TypedHoverOptionsOptions for opt-in typed hover overlays on TypeScript fences. Hover strings are compute…typesType definitions for @ox-content/vite-pluginVersionBannerKind = "unreleased" | "unmaintained"Banner shown on pages that belong to one documented version.VersionEntryOne published or snapshot version of a docs tree.VersionsOptionsOpt-in documentation versioning. Off by default. true enables a single current entry. A…WikiLinkOptionsOptions for expanding Obsidian-style wiki links. The transform accepts [target] and [ta…normalizeOgpUrl(url: string): stringNormalize a URL for cache keys: lowercase host, drop default ports and fragments, and s…version-navigationKeeps navigation inside a frozen documentation-version tree. Locale resolution runs bef…versions-htmlEscaped version switcher, banner, and badge markup.currentVersionPrefix(options?: ResolvedVersionsOptions): stringPrefix used for the active version (empty string = site root).decorateVersionedPages(pages: Array<{ outputPath: string; html: string }>, options: ResolvedVersionsOptions, outDir: string, base: string): voidApplies switcher / banner / search rewrite after every version tree is generated.resolveSnapshotDir(root: string, dir: string): string | undefinedConfines a snapshot dir to root.resolveVersionsOptions(value: boolean | VersionsOptions | undefined): ResolvedVersionsOptionsResolves versions. Omitted / false stay off. true enables a single current entry. An ob…versionLocation(outputPath: string, outDir: string, options: ResolvedVersionsOptions): { id: string; sibling: string }Version id and same-path remainder for a generated HTML file.versionsOpt-in documentation versioning: prefixes, snapshots, and header chrome. Historical sna…convertVitePressNav(nav: VitePressNavItem[]): SsgNavigationGroup[]Converts VitePress top navigation into ox-content sidebar groups. This is used as a fal…convertVitePressSidebar(sidebar: VitePressSidebar): SsgNavigationGroup[]Converts a VitePress sidebar config into ox-content navigation groups. Nested VitePress…fromVitePressConfig(config: VitePressConfig, overrides: OxContentOptions = {}): OxContentOptionsCreates ox-content plugin options from an existing VitePress config.generateVitePressMigrationConfig(config: VitePressConfig, overrides: OxContentOptions = {}, options: GenerateVitePressMigrationConfigOptions = {}): stringGenerates a TypeScript module exporting migrated ox-content options. This is used by th…normalizeVitePressFrontmatter(frontmatter: Record<string, unknown>): Record<string, unknown>Normalizes VitePress-specific frontmatter into ox-content's entry-page shape.extractVideoId(input: string): string | nullExtract a YouTube video ID from a bare ID or a watch / share / embed / shorts URL. The…transformYouTube(html: string, options?: YouTubeOptions): Promise<string>Transform YouTube components in HTML.youtubeYouTube Plugin - Privacy-enhanced iframe embedding Transforms <YouTube> components into…