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.prefetchGitHubSources(sources: GitHubSourceRef[], options?: GitHubOptions): Promise<Map<string, GitHubSourceData | null>>Pre-fetch all GitHub source files.collectGitHubRepos(html: string): Promise<string[]>Collect all GitHub repos from HTML for pre-fetching.collectGitHubSources(html: string): Promise<GitHubSourceRef[]>Collect all GitHub source references from HTML for pre-fetching.browserChromium browser session with automatic cleanup via Explicit Resource Management. Usage…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…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,…writeCache(cacheDir: string, key: string, png: Buffer): Promise<void>Writes a PNG buffer to the cache.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).renderPage(filePath: string, options: ResolvedOptions, navGroups: NavGroup[], siteName: string, base: string, root: string): Promise<string>Render a single markdown page to full HTML.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.resolveDocsOptions(options: false): falseResolves docs options with defaults.writeDocs(docs: Record<string, string>, outDir: string, extractedDocs?: ExtractedDocs[], options?: ResolvedDocsOptions): Promise<void>Writes generated documentation to the output directory.createEnvironmentPlugins(options: ResolvedOptions)Environment plugin factory. Creates plugins specific to the Markdown environment.createMarkdownEnvironment(options: ResolvedOptions): EnvironmentOptionsCreates the Markdown processing environment configuration. This environment is used for…createTransformOptions(ctx: EnvironmentTransformContext, options: ResolvedOptions): ResolvedOptionsCreates environment-aware transform options.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.applyPendingHighlights(html: string, replacements: string[]): stringSplices replacements back over the blocks the native pass left pending. Entry i is the…getTextContent(node: Element | Root): stringExtract text content from a hast node.highlight-nativeThe native tree-sitter highlighting path, plus the small hast helpers both engines read…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.…languageOf(codeElement: Element): string | nullThe language-* class on a <code> element, if it carries one.NativeDocumentWhat highlightDocumentNatively produced for a page.nativeSupports(lang: string): booleanWhether the native engine claims lang.PendingBlockA block the native pass left for another highlighter.treeNeedsShiki(tree: Root, nativeThemeApplies: boolean): booleanWhether any block in this tree still needs Shiki. Creating a Shiki highlighter parses t…highlight-pendingHighlighting the blocks the native pass could not claim. These arrive already named — t…highlightPendingBlocks(blocks: readonly { language: string; source: string }[], theme: string | ThemeRegistration = CSS_VARIABLES_THEME, langs: LanguageRegistration[] = []): Promise<string[]>Highlight the blocks the native pass left pending, in order. Entry i of the result is t…const lazyHighlighterCache = new Map<string, Promise<Highlighter>>()A highlighter that starts with no grammars and gains them on demand. getHighlighter loa…getHighlighter(theme: string | ThemeRegistration, customLangs: LanguageRegistration[] = []): Promise<Highlighter>Get or create the Shiki highlighter.highlightSyntax highlighting with Shiki via rehype.highlightCode(html: string, theme: string | ThemeRegistration = CSS_VARIABLES_THEME, langs: LanguageRegistration[] = []): Promise<string>Apply syntax highlighting to HTML using Shiki.rehypeShikiHighlight(options: { theme: string | ThemeRegistration; langs?: LanguageRegistration[]; })Rehype plugin for syntax highlighting with Shiki.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.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.resolveOptions(options: OxContentOptions): ResolvedOptionsResolves plugin options with defaults.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.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…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…resolveOgImageOptions(options: OgImageOptions | undefined): ResolvedOgImageOptionsResolves user-provided OG image options with defaults.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: OgImagePageEntry[], templateSource: string, options: ResolvedOgImageOptions, cacheDir: string): Promise<OgImageResult[] | null>Tries to serve all pages from cache. Returns results if ALL pages are cached, null othe…tsTemplateBundleOptions(templatePath: string)Rolldown input options for a .ts template bundle. A .ts template is the framework-less…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…TransformAllOptionsTransform 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; spotify?: boolean; stackBlitz?: boolean; twitter?: boolean | TwitterEmbedOptions; bluesky?: boolean; webContainer?: boolean; }): Promise<string>Transform built-in embed components in HTML content.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…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…mermaid-protectProtects mermaid SVG content from rehype HTML5 parser corruption. rehypeParse + rehypeS…MermaidSvgProtectionProtects mermaid SVG content from rehype HTML5 parser corruption. rehypeParse + rehypeS…protectMermaidSvgs(html: string): MermaidSvgProtectionExtract <div class="ox-mermaid">...</div> blocks and replace with HTML comment placehol…restoreMermaidSvgs(html: string, svgs: Map<string, string>): stringRestore protected mermaid SVG 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…og-viewerOG Viewer - Dev tool for previewing Open Graph metadata Accessible at /__og-viewer duri…collectOgpUrls(html: string): Promise<string[]>Collect all OGP URLs from HTML for pre-fetching.createFallbackCard(url: string): ElementCreate fallback element when OGP data is unavailable.createOgpCard(data: OgpData): ElementCreate OGP card element.extractDomain(url: string): stringExtract domain from URL.fetchOgpData(url: string, options: Required<OgpOptions>): Promise<OgpData | null>Fetch OGP data for a URL.getAttribute(el: Element, name: string): string | undefinedGet element attribute value.getFaviconUrl(url: string): stringGet favicon URL for a domain.ogpOGP Card Plugin - Link card embedding Transforms <OgCard> components into static link p…parseOgpFromHtml(html: string, url: string): OgpDataParse OGP metadata from HTML.prefetchOgpData(urls: string[], options?: OgpOptions): Promise<Map<string, OgpData | null>>Pre-fetch all OGP data.rehypeOgp(ogpDataMap: Map<string, OgpData | null>)Rehype plugin to transform OgCard components.transformOgp(html: string, ogpDataMap?: Map<string, OgpData | null>, options?: OgpOptions): Promise<string>Transform OgCard components in HTML.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.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…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.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.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.buildSearchIndex(srcDir: string, base: string, extensions: readonly string[] = DEFAULT_MARKDOWN_EXTENSIONS): Promise<string>Builds the search index from Markdown files.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.const CSS_VARIABLES_THEME = "css-variables"Name callers pass as highlightTheme to render syntax colors as CSS custom properties in…cssVariablesTheme(): ThemeRegistrationShiki theme whose every color is a --octc-shiki-* custom property. This is what lets sy…resolveHighlightTheme(theme: string | ThemeRegistration): string | ThemeRegistrationResolves the css-variables alias; any other value passes through.const VARIABLE_DEFAULTS: Record<string, string>Fallbacks baked into each var() so a site with no color scheme installed still renders…const VARIABLE_PREFIX = "--octc-shiki-"Prefix for the emitted properties, matching the rest of the design tokens.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.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…generateHtmlPage(pageData: SsgPageData, navGroups: NavGroup[], siteName: string, base: string, ogImage?: string, theme?: ResolvedThemeConfig, locale?: string, availableLocales?: LocaleConfig[]): Promise<string>Generates HTML page with navigation using Rust NAPI bindings.getHref(inputPath: string, srcDir: string, base: string, extension: string): stringConverts a markdown file path to an href.getOutputPath(inputPath: string, srcDir: string, outDir: string, extension: string): stringConverts a markdown file path to its corresponding HTML output path.getUrlPath(inputPath: string, srcDir: 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…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…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.toRustTocEntry(entry: TocEntry): TocEntryConverts a TocEntry tree into the plain shape the Rust binding expects. Hoisted to modu…toThemePageData(pageResult: PageProcessResult): 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.escapeHtml(str: string): stringEscapes HTML special characters.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…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.ThemeTokens = Record<string, string>Free-form --octc-* custom properties for themes that need more than the typed colors /…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…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.ThemeFooterTheme footer configuration.ThemeHeaderTheme header configuration.ThemeLayoutTheme layout configuration.themeToNapi(theme: ResolvedThemeConfig): NapiThemeConfigConverts resolved theme to the format expected by Rust NAPI.rehypeGitHub(repoDataMap: Map<string, GitHubRepoData | null>, sourceDataMap: Map<string, GitHubSourceData | null>, options: Required<GitHubOptions>)Rehype plugin to transform GitHub components.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[], filePath: string, _options: ResolvedOptions): stringGenerates the JavaScript module code.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…NapiBindingsNAPI bindings for Rust-based Markdown processing. Provides access to compiled Rust func…OgImageConfigOG image configuration.OgImageDataOG image data for generating social media preview images.SsgTransformOptionsSSG-specific transform options.transformMarkdown Transformation Engine This module handles the complete transformation pipeline…OgImageOptionsOG image generation options (user-facing).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 Chromium-based OG image generation.AttrsOptionsOptions for markdown-it-attrs style attribute blocks. Attribute blocks let authors atta…BuiltinEmbedOptionsBuilt-in embed configuration.BuiltinPmOptionsOptions for the package-manager install-tab transform.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…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.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.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…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.GeneratedDocsDataMachine-readable payload emitted alongside generated docs.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…LocaleConfigLocale configuration. Locales define the routing and display metadata used by the i18n…MarkdownNodeMarkdown AST node (simplified for TypeScript).MarkdownTransformerCustom AST transformer.NavItemNavigation item for sidebar navigation.OgImageOptionsOG image generation options. Uses Chromium-based rendering with customizable templates.OxContentOptionsOptions for the core oxContent() Vite plugin. The top-level options describe where cont…ParamDocParameter documentation.ResolvedAttrsOptionsResolved attrs transform options.ResolvedBuiltinEmbedOptionsResolved built-in embed configuration.ResolvedCodeAnnotationsOptionsResolved code annotation configuration.ResolvedCodeBlockLintOptionsResolved code-block lint options.ResolvedCodeBlockTypecheckOptionsResolved code-block type-check options.ResolvedCodeImportOptionsResolved code-import transform options.ResolvedCollectionOptionsResolved collection definition.ResolvedCollectionsOptionsResolved collection 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.ResolvedI18nOptionsResolved i18n options with all defaults applied.ResolvedOgImageOptionsResolved OG image options with all defaults applied.ResolvedOptionsResolved options with all defaults applied.ResolvedSanitizeOptionsResolved sanitize transform options.ResolvedSearchOptionsResolved search options.ResolvedSsgOptionsResolved SSG options.ResolvedWikiLinkOptionsResolved wiki-link transform options.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.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…ThrowsDocException/error documentation.TocEntryTable of contents entry.TransformContextTransform context passed to transformers.TransformResultTransform result.typesType definitions for @ox-content/vite-pluginWikiLinkOptionsOptions for expanding Obsidian-style wiki links. The transform accepts [target] and [ta…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 YouTube video ID from various URL formats.transformYouTube(html: string, options?: YouTubeOptions): Promise<string>Transform YouTube components in HTML.youtubeYouTube Plugin - Privacy-enhanced iframe embedding Transforms <YouTube> components into…