API Documentation#

Use search scopes like @api transform to limit results to the generated API reference.

47 modules 377 symbols 177 functions 135 interfaces 13 types 16 variables 36 modules 321 parameters 779 members 173 returns 20 examples 2 deprecated

Modules#

api 4 symbols

fn
fetchGitHubSource(source: GitHubSourceRef, options: Required<GitHubOptions>): Promise<GitHubSourceData | null>Fetch source file data from GitHub API.2 paramsreturns Promise<GitHubSourceData | null>
fn
fetchRepoData(repo: string, options: Required<GitHubOptions>): Promise<GitHubRepoData | null>Fetch repository data from GitHub API.2 paramsreturns Promise<GitHubRepoData | null>
fn
prefetchGitHubRepos(repos: string[], options?: GitHubOptions): Promise<Map<string, GitHubRepoData | null>>Pre-fetch all GitHub repos data.2 paramsreturns Promise<Map<string, GitHubRepoData | null>>
fn
prefetchGitHubSources(sources: GitHubSourceRef[], options?: GitHubOptions): Promise<Map<string, GitHubSourceData | null>>Pre-fetch all GitHub source files.2 paramsreturns Promise<Map<string, GitHubSourceData | null>>

attributes 2 symbols

fn
collectGitHubRepos(html: string): Promise<string[]>Collect all GitHub repos from HTML for pre-fetching.1 paramreturns Promise<string[]>
fn
collectGitHubSources(html: string): Promise<GitHubSourceRef[]>Collect all GitHub source references from HTML for pre-fetching.1 paramreturns Promise<GitHubSourceRef[]>

browser 3 symbols

module
browserChromium browser session with automatic cleanup via Explicit Resource Management. Usage…
interface
OgBrowserSession extends AsyncDisposableA browser session that can render HTML pages to PNG. Implements AsyncDisposable for aut…1 member
fn
openBrowser(): Promise<OgBrowserSession | null>Opens a Chromium browser and returns a session for rendering OG images. Returns null if…returns Promise<OgBrowserSession | null>

cache 4 symbols

module
cacheContent-hash based caching for OG images. Uses SHA256 of (template source + props + opt…
fn
computeCacheKey(templateSource: string, props: Record<string, unknown>, width: number, height: number): stringComputes a cache key from template + props + options.4 paramsreturns string
fn
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,…2 paramsreturns Promise<Buffer | null>
fn
writeCache(cacheDir: string, key: string, png: Buffer): Promise<void>Writes a PNG buffer to the cache.3 paramsreturns Promise<void>

dev-server 13 symbols

fn
createDevServerCache(): DevServerCacheCreate a dev server cache instance.returns DevServerCache
fn
createDevServerMiddleware(options: ResolvedOptions, root: string, cache: DevServerCache): Connect.NextHandleFunctionCreate the dev server middleware for SSG page serving.3 paramsreturns Connect.NextHandleFunction
module
dev-serverDev server middleware for ox-content SSG. Serves fully-rendered HTML pages (with naviga…
interface
DevServerCacheDev server state for caching.3 members
fn
injectViteHmrClient(html: string): stringInject Vite HMR client script into the HTML.1 paramreturns string
fn
invalidateNavCache(cache: DevServerCache): voidInvalidate navigation cache (called on file add/unlink).1 paramreturns void
fn
invalidatePageCache(cache: DevServerCache, filePath: string): voidInvalidate page cache for a specific file (called on file change).2 paramsreturns void
fn
renderPage(filePath: string, options: ResolvedOptions, navGroups: NavGroup[], siteName: string, base: string, root: string): Promise<string>Render a single markdown page to full HTML.6 paramsreturns Promise<string>
fn
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.3 paramsreturns Promise<string | null>
fn
resolveSiteName(options: ResolvedOptions, root: string): Promise<string>Resolve site name from options or package.json.2 paramsreturns Promise<string>
fn
shouldSkip(url: string): booleanCheck if a request URL should be skipped by the dev server middleware.1 paramreturns boolean
variable
const SKIP_EXTENSIONS = new Set([ ".js", ".ts", ".css", ".scss", ".less", ".svg", ".png", ".jpg", ".jpeg", ".gif", ".webp", ".ico", ".woff", ".woff2", ".ttf", ".eot", ".json", ".map", ".mp4", ".webm", ".mp3", ".pdf", ])File extensions to skip in the middleware.
variable
const VITE_INTERNAL_PREFIXES = ["/@vite/", "/@fs/", "/@id/", "/__"]Vite internal URL prefixes to skip.

docs 6 symbols

module
docsSource Documentation Extraction and Generation This module provides comprehensive tools…1 example
fn
existingGeneratedAt(outDir: string): string | undefinedKeep docs.json's timestamp stable across regenerations of the same tree.1 paramreturns string | undefined
fn
extractDocs(srcDirs: string[], options: ResolvedDocsOptions): Promise<ExtractedDocs[]>Extracts JSDoc documentation from source files in specified directories. This function…2 paramsreturns Promise<ExtractedDocs[]>1 example
fn
generateMarkdown(docs: ExtractedDocs[], options: ResolvedDocsOptions): Record<string, string>Generates Markdown documentation from extracted docs.2 paramsreturns Record<string, string>
fn
resolveDocsOptions(options: false): falseResolves docs options with defaults.1 paramreturns false
fn
writeDocs(docs: Record<string, string>, outDir: string, extractedDocs?: ExtractedDocs[], options?: ResolvedDocsOptions): Promise<void>Writes generated documentation to the output directory.4 paramsreturns Promise<void>

environment 6 symbols

fn
createEnvironmentPlugins(options: ResolvedOptions)Environment plugin factory. Creates plugins specific to the Markdown environment.1 param
fn
createMarkdownEnvironment(options: ResolvedOptions): EnvironmentOptionsCreates the Markdown processing environment configuration. This environment is used for…1 paramreturns EnvironmentOptions1 example
fn
createTransformOptions(ctx: EnvironmentTransformContext, options: ResolvedOptions): ResolvedOptionsCreates environment-aware transform options.2 paramsreturns ResolvedOptions
module
environmentVite Environment API integration for Ox Content. Creates a dedicated environment for Ma…
interface
EnvironmentTransformContextEnvironment-specific module transformer. This is called during the transform phase to p…4 members
fn
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…2 paramsreturns Promise<Map<string, string>>

fallback-card 1 symbol

fn
createFallbackCard(repo: string): ElementCreate fallback element when repo data is unavailable.1 paramreturns Element

highlight-native 10 symbols

fn
applyPendingHighlights(html: string, replacements: string[]): stringSplices replacements back over the blocks the native pass left pending. Entry i is the…2 paramsreturns string
fn
getTextContent(node: Element | Root): stringExtract text content from a hast node.1 paramreturns string
module
highlight-nativeThe native tree-sitter highlighting path, plus the small hast helpers both engines read…
fn
highlightDocumentNatively(html: string): Promise<NativeDocument | null>Highlights every code block in a rendered document in one native call. Returns the rewr…1 paramreturns Promise<NativeDocument | null>
fn
highlightNatively(code: string, lang: string): string | nullHighlights with the native tree-sitter engine, or null when it has no grammar for lang.…2 paramsreturns string | null
fn
languageOf(codeElement: Element): string | nullThe language-* class on a <code> element, if it carries one.1 paramreturns string | null
interface
NativeDocumentWhat highlightDocumentNatively produced for a page.3 members
fn
nativeSupports(lang: string): booleanWhether the native engine claims lang.1 paramreturns boolean
interface
PendingBlockA block the native pass left for another highlighter.2 members
fn
treeNeedsShiki(tree: Root, nativeThemeApplies: boolean): booleanWhether any block in this tree still needs Shiki. Creating a Shiki highlighter parses t…2 paramsreturns boolean

highlight-pending 3 symbols

module
highlight-pendingHighlighting the blocks the native pass could not claim. These arrive already named — t…
fn
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…3 paramsreturns Promise<string[]>
variable
const lazyHighlighterCache = new Map<string, Promise<Highlighter>>()A highlighter that starts with no grammars and gains them on demand. getHighlighter loa…

highlight 4 symbols

fn
getHighlighter(theme: string | ThemeRegistration, customLangs: LanguageRegistration[] = []): Promise<Highlighter>Get or create the Shiki highlighter.2 paramsreturns Promise<Highlighter>
module
highlightSyntax highlighting with Shiki via rehype.
fn
highlightCode(html: string, theme: string | ThemeRegistration = CSS_VARIABLES_THEME, langs: LanguageRegistration[] = []): Promise<string>Apply syntax highlighting to HTML using Shiki.3 paramsreturns Promise<string>
fn
rehypeShikiHighlight(options: { theme: string | ThemeRegistration; langs?: LanguageRegistration[]; })Rehype plugin for syntax highlighting with Shiki.3 params

i18n 4 symbols

fn
createI18nPlugin(resolvedOptions: ResolvedOptions): PluginCreates the i18n sub-plugin for the Vite plugin array.1 paramreturns Plugin
fn
generateI18nModule(options: ResolvedI18nOptions, root: string): stringGenerates the virtual module for i18n configuration.2 paramsreturns string
module
i18ni18n plugin for Ox Content. Provides: - Dictionary loading and validation at build time…
fn
resolveI18nOptions(options: I18nOptions | false | undefined): ResolvedI18nOptions | falseResolves i18n options with defaults.1 paramreturns ResolvedI18nOptions | false

index 4 symbols

fn
generateVirtualModule(path: string, options: ResolvedOptions): stringGenerates virtual module content.2 paramsreturns string
module
indexVite Plugin for Ox Content Uses Vite's Environment API for SSG-focused Markdown process…
fn
oxContent(options: OxContentOptions = {}): Plugin[]Creates the Ox Content Vite plugin.1 paramreturns Plugin[]1 example
fn
resolveOptions(options: OxContentOptions): ResolvedOptionsResolves plugin options with defaults.1 paramreturns ResolvedOptions

index 1 symbol

module
indexIsland Architecture support for ox-content Provides parsing and transformation of <Isla…

index 18 symbols

fn
computeTemplateSource(options: ResolvedOgImageOptions, root: string): Promise<string>Computes a stable template source identifier for cache keys. For custom templates, hash…2 paramsreturns Promise<string>
fn
createSvelteCompilerPlugin(): import("rolldown").PluginCreates a rolldown plugin that compiles Svelte SFCs using svelte/compiler.returns import("rolldown").Plugin
fn
createVueCompilerPlugin(): import("rolldown").PluginCreates a rolldown plugin that compiles Vue SFCs using @vue/compiler-sfc.returns import("rolldown").Plugin
fn
generateOgImages(pages: OgImagePageEntry[], options: ResolvedOgImageOptions, root: string): Promise<OgImageResult[]>Generates OG images for a batch of pages. Manages the full lifecycle: resolve template…3 paramsreturns Promise<OgImageResult[]>
fn
getVizejsPlugin(): Promise<import("rolldown").Plugin[]>Loads @vizejs/vite-plugin as a rolldown plugin for Vue SFC compilation.returns Promise<import("rolldown").Plugin[]>
fn
isBareSpecifier(id: string): booleanWhether id is a bare specifier, and so resolvable at runtime rather than something the…1 paramreturns boolean
interface
OgImagePageEntryA single page entry for batch OG image generation.2 members
interface
OgImageResultResult of OG image generation for a single page.3 members
variable
const OX_CONTENT_PACKAGE = /^@ox-content\/vite-plugin(\/.*)?$/Matches this package and every subpath it exports. A template's natural runtime is what…
fn
renderSinglePage(entry: OgImagePageEntry, templateFn: OgImageTemplateFn, templateSource: string, options: ResolvedOgImageOptions, cacheDir: string, session: OgBrowserSession, publicDir?: string): Promise<OgImageResult>Renders a single page to PNG, with cache support.7 paramsreturns Promise<OgImageResult>
fn
resolveOgImageOptions(options: OgImageOptions | undefined): ResolvedOgImageOptionsResolves user-provided OG image options with defaults.1 paramreturns ResolvedOgImageOptions
fn
resolveReactTemplate(templatePath: string, root: string): Promise<OgImageTemplateFn>Resolves a React (.tsx/.jsx) template via SSR. Bundles with rolldown (JSX transform), t…2 paramsreturns Promise<OgImageTemplateFn>
fn
resolveSvelteTemplate(templatePath: string, root: string): Promise<OgImageTemplateFn>Resolves a Svelte SFC template via SSR. Compiles the SFC with svelte/compiler (server m…2 paramsreturns Promise<OgImageTemplateFn>
fn
resolveTemplate(options: ResolvedOgImageOptions, root: string): Promise<OgImageTemplateFn>Resolves the template function from options. Dispatches by file extension: - .vue → Vue…2 paramsreturns Promise<OgImageTemplateFn>
fn
resolveTsTemplate(templatePath: string, options: ResolvedOgImageOptions, root: string): Promise<OgImageTemplateFn>Resolves a plain TypeScript template (existing behavior).3 paramsreturns Promise<OgImageTemplateFn>
fn
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…3 paramsreturns Promise<OgImageTemplateFn>
fn
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…4 paramsreturns Promise<OgImageResult[] | null>
fn
tsTemplateBundleOptions(templatePath: string)Rolldown input options for a .ts template bundle. A .ts template is the framework-less…1 param

index 5 symbols

module
indexox-content Built-in Plugins All plugins are designed with No-JavaScript-First principle…
fn
normalizeSelfClosingEmbeds(html: string): stringCustom embed tags are not HTML void elements, so a self-closing authoring form like <Gi…1 paramreturns string
interface
TransformAllOptionsTransform all plugin components in HTML. Call this during SSG build to process all plug…13 members
fn
transformAllPlugins(html: string, options: TransformAllOptions = {}): Promise<string>Transform all enabled plugins in HTML content.2 paramsreturns Promise<string>
fn
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.10 paramsreturns Promise<string>

interop 2 symbols

module
interopInterop helpers for loading ESM-only dependencies from the CommonJS build.
fn
interopDefault<T>(value: T): TUnwrap the default export of an ESM-only dependency. The CommonJS build (dist/index.cjs…1 paramreturns T

jsx-dev-runtime 3 symbols

module
jsx-dev-runtimeDevelopment-runtime entry point for the static HTML JSX transform. TypeScript's react-j…1 example
fn
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…6 paramsreturns JSXNode
interface
JSXSourceSource position the dev transform attaches to each element.3 members

jsx-html 18 symbols

variable
const ATTR_ALIASES: Record<string, string>React prop names whose HTML spelling is not the lowercased identifier.
fn
each<T>(items: T[], render: (item: T, index: number) => JSXNode): JSXNodeMaps over an array and renders each item.2 paramsreturns JSXNode1 example
fn
escapeHtml(str: string): stringEscapes HTML special characters to prevent XSS.1 paramreturns string
fn
Fragment({ children }: { children?: JSXChild }): JSXNodeFragment component - renders children without a wrapper element.2 paramsreturns JSXNode
fn
jsx(type: JSXElementType, props: JSXProps, _key?: string): JSXNodeCreates a JSX element. This is the core function called by the JSX transform.3 paramsreturns JSXNode
module
jsx-htmlCustom JSX Runtime for Static HTML Generation This module provides a JSX runtime that o…1 example
type
JSXChild = string | number | boolean | null | undefined | JSXNode | JSXChild[]Valid JSX child types.
type
JSXElementType = string | ((props: Record<string, unknown>) => JSXNode)JSX element type - either a string (intrinsic) or a function component.
interface
JSXNodeJSX node - the result of JSX expressions.1 member
interface
JSXPropsProps with children.2 members
fn
jsxs(type: JSXElementType, props: JSXProps, key?: string): JSXNodeCreates a JSX element with static children. Called by the JSX transform for elements wi…3 paramsreturns JSXNode
fn
raw(html: string): JSXNodeCreates raw HTML without escaping. Use with caution - only for trusted content.1 paramreturns JSXNode1 example
fn
renderAttr(name: string, value: unknown): stringRenders an attribute value to a string.2 paramsreturns string
fn
renderChildren(children: JSXChild): stringRenders children to HTML string.1 paramreturns string
fn
renderToString(node: JSXNode): stringRenders a JSX node to an HTML string.1 paramreturns string
variable
const SVG_CAMEL_CASE = new Set(["viewBox"])SVG attributes that stay camelCase in HTML (they are case-sensitive).
fn
toHtmlAttr(name: string): stringConverts a JSX/React prop name to the HTML attribute the runtime emits. HTML attributes…1 paramreturns string
fn
when(condition: boolean, content: JSXNode): JSXNodeConditionally renders content.2 paramsreturns JSXNode1 example

jsx-runtime 1 symbol

module
jsx-runtimeAutomatic-runtime entry point for the static HTML JSX transform. jsxImportSource makes…1 example

jsx.d 1 symbol

module
jsx.dJSX Type Definitions for Static HTML Generation These types enable TypeScript support f…

lint-files 7 symbols

fn
lintMarkdownFile(filePath: string, options: MarkdownLintFileOptions = {}): Promise<MarkdownLintFileResult>Lints a single Markdown file using project-style include/exclude settings. If the file…2 paramsreturns Promise<MarkdownLintFileResult>
fn
lintMarkdownFiles(options: MarkdownLintFileOptions = {}): Promise<MarkdownLintFilesResult>Lints all Markdown files matched by the configured include/exclude patterns.1 paramreturns Promise<MarkdownLintFilesResult>
interface
MarkdownLintFileDiagnostic extends MarkdownLintDiagnosticA lint diagnostic annotated with file metadata.2 members
interface
MarkdownLintFileOptions extends MarkdownLintOptionsFile-oriented Markdown lint options for end-user configuration. This extends the conten…4 members
interface
MarkdownLintFileResult extends MarkdownLintResultLint result for a single file.3 members
interface
MarkdownLintFilesResultAggregated lint result for multiple files.6 members
fn
shouldLintMarkdownFile(filePath: string, options: MarkdownLintFileOptions = {}): booleanReturns true if the file path is included by the configured glob filters.2 paramsreturns boolean

lint 9 symbols

fn
lintMarkdown(source: string, options: MarkdownLintOptions = {}): MarkdownLintResultLints Markdown prose with the Rust-backed built-in rule engine.2 paramsreturns MarkdownLintResult
fn
lintMarkdownAsync(source: string, options: MarkdownLintOptions = {}): Promise<MarkdownLintResult>Async Markdown linter that supports opt-in standard dictionaries.2 paramsreturns Promise<MarkdownLintResult>
fn
lintMarkdownDocumentsAsync(sources: string[], options: MarkdownLintOptions = {}): Promise<MarkdownLintResult[]>Internal batched Markdown linting entry point used by file-based workflows.2 paramsreturns Promise<MarkdownLintResult[]>
interface
MarkdownLintDiagnosticA single Markdown lint diagnostic.9 members
interface
MarkdownLintDictionaryOptionsAdditional dictionary configuration for the Markdown linter.4 members
interface
MarkdownLintOptionsOptions for linting Markdown documents.3 members
interface
MarkdownLintResultMarkdown lint report.4 members
interface
MarkdownLintRuleOptionsRule switches for Markdown linting.7 members
interface
MarkdownLintStandardDictionaryOptionsOpt-in standard dictionary sources. The default provider uses CSpell dictionary package…4 members

mermaid-protect 4 symbols

module
mermaid-protectProtects mermaid SVG content from rehype HTML5 parser corruption. rehypeParse + rehypeS…
interface
MermaidSvgProtectionProtects mermaid SVG content from rehype HTML5 parser corruption. rehypeParse + rehypeS…2 members
fn
protectMermaidSvgs(html: string): MermaidSvgProtectionExtract <div class="ox-mermaid">...</div> blocks and replace with HTML comment placehol…1 paramreturns MermaidSvgProtection
fn
restoreMermaidSvgs(html: string, svgs: Map<string, string>): stringRestore protected mermaid SVG blocks from placeholders.2 paramsreturns string

mermaid 4 symbols

module
mermaidMermaid Plugin - Native Rust renderer via NAPI Renders mermaid code blocks to SVG using…
variable
const mermaidClientScript = ""deprecated
variable
let napiBindings: { transformMermaid: (html: string, mmdcPath: string) => { html: string; errors: string[] } } | nullCached NAPI bindings
fn
transformMermaidStatic(html: string, _options?: MermaidOptions): Promise<string>Transforms mermaid code blocks in HTML to rendered SVG diagrams. Uses the native Rust N…2 paramsreturns Promise<string>

og-viewer 1 symbol

module
og-viewerOG Viewer - Dev tool for previewing Open Graph metadata Accessible at /__og-viewer duri…

ogp 12 symbols

fn
collectOgpUrls(html: string): Promise<string[]>Collect all OGP URLs from HTML for pre-fetching.1 paramreturns Promise<string[]>
fn
createFallbackCard(url: string): ElementCreate fallback element when OGP data is unavailable.1 paramreturns Element
fn
createOgpCard(data: OgpData): ElementCreate OGP card element.1 paramreturns Element
fn
extractDomain(url: string): stringExtract domain from URL.1 paramreturns string
fn
fetchOgpData(url: string, options: Required<OgpOptions>): Promise<OgpData | null>Fetch OGP data for a URL.2 paramsreturns Promise<OgpData | null>
fn
getAttribute(el: Element, name: string): string | undefinedGet element attribute value.2 paramsreturns string | undefined
fn
getFaviconUrl(url: string): stringGet favicon URL for a domain.1 paramreturns string
module
ogpOGP Card Plugin - Link card embedding Transforms <OgCard> components into static link p…
fn
parseOgpFromHtml(html: string, url: string): OgpDataParse OGP metadata from HTML.2 paramsreturns OgpData
fn
prefetchOgpData(urls: string[], options?: OgpOptions): Promise<Map<string, OgpData | null>>Pre-fetch all OGP data.2 paramsreturns Promise<Map<string, OgpData | null>>
fn
rehypeOgp(ogpDataMap: Map<string, OgpData | null>)Rehype plugin to transform OgCard components.1 param
fn
transformOgp(html: string, ogpDataMap?: Map<string, OgpData | null>, options?: OgpOptions): Promise<string>Transform OgCard components in HTML.3 paramsreturns Promise<string>

optional-deps.d 1 symbol

module
optional-deps.dAmbient module declarations for optional dependencies. These packages are dynamically i…

page-context 15 symbols

interface
BasePagePropsBase page props available for all pages.9 members
interface
FrontmatterSchemaSchema for frontmatter type generation.4 members
fn
generateFrontmatterTypes(samples: Record<string, unknown>[], interfaceName = "PageFrontmatter"): stringGenerates TypeScript interface from frontmatter samples.2 paramsreturns string
fn
inferType(value: unknown): stringInfers TypeScript types from frontmatter values.1 paramreturns string
interface
NavGroupNavigation group.2 members
interface
NavItemNavigation item.3 members
module
page-contextPage Context for Static HTML Generation Provides a way to access page props (frontmatte…1 example
type
PageProps<T extends Record<string, unknown> = Record<string, unknown>> = BasePageProps & { frontmatter: T & Record<string, unknown> }Extended page props with custom frontmatter.1 member
interface
RenderContext<T extends Record<string, unknown> = Record<string, unknown>>Complete render context.2 members
interface
SiteConfigSite-wide configuration available in context.4 members
fn
useIsActive(path: string): booleanChecks if the given path is the current page.1 paramreturns boolean1 example
fn
useNav(): NavGroup[]Gets the navigation groups.returns NavGroup[]1 example
fn
usePageProps< T extends Record<string, unknown> = Record<string, unknown>, >(): PageProps<T>Gets the current page props.returns PageProps<T>1 example
fn
useRenderContext< T extends Record<string, unknown> = Record<string, unknown>, >(): RenderContext<T>Gets the full render context.returns RenderContext<T>1 example
fn
useSiteConfig(): SiteConfigGets the site configuration.returns SiteConfig1 example

parse 11 symbols

fn
extractIslandInfo(html: string): Promise<IslandInfo[]>Extract island info without transforming HTML. Useful for analysis/bundling purposes.1 paramreturns Promise<IslandInfo[]>
fn
findComponentElement(children: Element["children"]): Element | nullFind the component element inside <Island>.1 paramreturns Element | null
fn
generateHydrationScript(components: string[]): stringGenerate client-side hydration script. This is a minimal script that imports and initia…1 paramreturns string
fn
getAttribute(el: Element, name: string): string | undefinedGet element attribute value.2 paramsreturns string | undefined
fn
getComponentName(el: Element): stringGet component name from child element.1 paramreturns string
fn
hasIslands(html: string): booleanCheck if HTML contains any Island components.1 paramreturns boolean
module
parseIsland Parser Detects <Island> components in HTML and transforms them into hydration-re…
fn
parseProps(el: Element): Record<string, unknown>Parse JSX-style props from attributes.1 paramreturns Record<string, unknown>
fn
rehypeIslands(collectedIslands: IslandInfo[])Rehype plugin to transform Island components.1 param
fn
resetIslandCounter(): voidReset island counter (for testing).returns void
fn
transformIslands(html: string): Promise<ParseIslandsResult>Transform Island components in HTML. Converts: ``html <Island load="visible"> <Counter…1 paramreturns Promise<ParseIslandsResult>

pm 3 symbols

module
pmPackage Manager Tabs Plugin Transforms <pm>npm install …</pm> blocks into a tab group w…
interface
PmOptionsOptions for transformPm.1 member
fn
transformPm(html: string, options?: PmOptions): Promise<string>Transform <pm> package-manager blocks in HTML into install tabs.2 paramsreturns Promise<string>

renderer 3 symbols

module
rendererHTML → PNG renderer using Chromium screenshots via Playwright.
fn
renderHtmlToPng(page: Page, html: string, width: number, height: number, publicDir?: string): Promise<Buffer>Renders an HTML string to a PNG buffer using Chromium.5 paramsreturns Promise<Buffer>
fn
wrapHtml(bodyHtml: string, width: number, height: number, useBaseUrl: boolean): stringWraps template HTML in a minimal document with viewport locked to given dimensions.4 paramsreturns string

repo-card 1 symbol

fn
createGitHubCard(repoData: GitHubRepoData): ElementCreate GitHub card element from repo data.1 paramreturns Element

search 8 symbols

fn
buildSearchIndex(srcDir: string, base: string, extensions: readonly string[] = DEFAULT_MARKDOWN_EXTENSIONS): Promise<string>Builds the search index from Markdown files.3 paramsreturns Promise<string>
fn
generateSearchModule(options: ResolvedSearchOptions, indexPath: string): stringClient-side search module code. This is injected into the bundle as a virtual module.2 paramsreturns string
fn
getSearchDocumentScopes(doc: Pick<SearchDocument, "id" | "url">): string[]Derives hierarchical search scopes from a document id or URL. For example, api/math/ind…1 paramreturns string[]
fn
matchesSearchScopes(doc: Pick<SearchDocument, "id" | "url">, scopes: string[]): booleanReturns true when a search document belongs to at least one requested scope.2 paramsreturns boolean
fn
parseScopedSearchQuery(query: string): ScopedSearchQuerySplits a raw query into free-text terms and @scope prefixes.1 paramreturns ScopedSearchQuery
fn
resolveSearchOptions(options: SearchOptions | boolean | undefined): ResolvedSearchOptionsResolves search options with defaults.1 paramreturns ResolvedSearchOptions
module
searchFull-text search functionality for Ox Content. Generates search index at build time and…
fn
writeSearchIndex(indexJson: string, outDir: string): Promise<void>Writes the search index to a file.2 paramsreturns Promise<void>

shiki-theme 5 symbols

variable
const CSS_VARIABLES_THEME = "css-variables"Name callers pass as highlightTheme to render syntax colors as CSS custom properties in…
fn
cssVariablesTheme(): ThemeRegistrationShiki theme whose every color is a --octc-shiki-* custom property. This is what lets sy…returns ThemeRegistration
fn
resolveHighlightTheme(theme: string | ThemeRegistration): string | ThemeRegistrationResolves the css-variables alias; any other value passes through.1 paramreturns string | ThemeRegistration
variable
const VARIABLE_DEFAULTS: Record<string, string>Fallbacks baked into each var() so a site with no color scheme installed still renders…
variable
const VARIABLE_PREFIX = "--octc-shiki-"Prefix for the emitted properties, matching the rest of the design tokens.

ssg 31 symbols

fn
buildNavItems(markdownFiles: string[], srcDir: string, base: string, extension: string): NavGroup[]Builds navigation items from markdown files, grouped by directory.4 paramsreturns NavGroup[]
fn
buildSsg(options: ResolvedOptions, root: string): Promise<SsgBuildResult>Builds all markdown files to static HTML.2 paramsreturns Promise<SsgBuildResult>
fn
buildThemeNavItems(sidebar: SidebarItem[], base: string, extension: string): NavGroup[]Builds navigation items from an explicit theme sidebar tree.3 paramsreturns NavGroup[]
fn
canonicalPageUrl(context: BuildSsgContext, urlPath: string): string | undefinedAbsolute URL of a page, or undefined when ssg.siteUrl is not set. Built the same way ge…2 paramsreturns string | undefined
fn
collectMarkdownFiles(srcDir: string, extensions: readonly string[] = DEFAULT_MARKDOWN_EXTENSIONS): Promise<string[]>Collects all markdown files from the source directory.2 paramsreturns Promise<string[]>
variable
const DEFAULT_HTML_TEMPLATE = ""Deprecated compatibility export for consumers that imported the former TypeScript SSG t…deprecated
fn
extractTitle(content: string, frontmatter: Record<string, unknown>): stringExtracts title from content or frontmatter.2 paramsreturns string
fn
formatTitle(name: string): stringFormats a file/dir name as a title.1 paramreturns string
fn
generateBareHtmlPage(content: string, title: string): stringGenerates bare HTML page (no navigation, no styles).2 paramsreturns string
fn
generateBarePage(page: SsgBarePage): stringGenerates a bare HTML page carrying head metadata and injected markup. Bare mode leaves…1 paramreturns string
fn
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.8 paramsreturns Promise<string>
fn
getHref(inputPath: string, srcDir: string, base: string, extension: string): stringConverts a markdown file path to an href.4 paramsreturns string
fn
getOutputPath(inputPath: string, srcDir: string, outDir: string, extension: string): stringConverts a markdown file path to its corresponding HTML output path.4 paramsreturns string
fn
getUrlPath(inputPath: string, srcDir: string): stringConverts a markdown file path to a relative URL path.2 paramsreturns string
variable
const localeCodesCache = new WeakMap<LocaleConfig[], string[]>()Per-build cache for the locale-code list passed to getSsgPageLocale. The i18n.locales r…
interface
NavGroupNavigation group for hierarchical navigation.4 members
variable
const navGroupsForRustCache = new WeakMap<NavGroup[], RustNavGroup[]>()Per-build cache for the Rust-facing nav conversion. navGroups is the same context.navIt…
fn
resolveNavigationGroups(navigation: SsgNavigationGroup[] | undefined, base: string, extension: string): NavGroup[] | undefinedResolves manual navigation config to the format used by the built-in SSG renderer.3 paramsreturns NavGroup[] | undefined
fn
resolveSsgOptions(ssg: SsgOptions | boolean | undefined): ResolvedSsgOptionsResolves SSG options with defaults.1 paramreturns ResolvedSsgOptions
interface
RustLocaleRust-facing locale shape.3 members
variable
const rustLocalesCache = new WeakMap<LocaleConfig[], RustLocale[]>()Per-build cache for the Rust-facing locale list. i18n.locales is the same reference for…
interface
RustNavGroupNAPI-facing nav group shape produced from a NavGroup.4 members
fn
shouldGenerateOgImages(options: ResolvedOptions): booleanWhether this build emits one Open Graph image per page. ssg.bare deliberately does not…1 paramreturns boolean
module
ssgSSG (Static Site Generation) module for ox-content
interface
SsgBarePageHead metadata and injected markup for a bare page.11 members
interface
SsgBuildResultResult of an SSG build.3 members
interface
SsgEntryPageConfigEntry page configuration for SSG (passed to Rust).2 members
interface
SsgNavItemNavigation item for SSG.6 members
interface
SsgPageDataPage data for SSG.9 members
fn
toRustTocEntry(entry: TocEntry): TocEntryConverts a TocEntry tree into the plain shape the Rust binding expects. Hoisted to modu…1 paramreturns TocEntry
fn
toThemePageData(pageResult: PageProcessResult): ThemePageDataMaps an internal page result onto the theme renderer's page shape.1 paramreturns ThemePageData

tabs 6 symbols

fn
generateTabsCSS(groupCount: number): stringGenerate dynamic CSS for :has() based tab switching. This is needed because :has() sele…1 paramreturns string
fn
getTabGroupCounter(): numberRead the shared tab group counter. Other tab-like transforms (such as the package-manag…returns number
fn
resetTabGroupCounter(): voidReset tab group counter (for testing and per dev-server request).returns void
fn
setTabGroupCounter(value: number): voidSet the shared tab group counter (advanced by other tab-like transforms).1 paramreturns void
module
tabsTabs Plugin - Pure CSS implementation Transforms <Tabs>/<Tab> components into accessibl…
fn
transformTabs(html: string): Promise<string>Transform Tabs components in HTML.1 paramreturns Promise<string>

template 3 symbols

fn
escapeHtml(str: string): stringEscapes HTML special characters.1 paramreturns string
fn
getDefaultTemplate(): OgImageTemplateFnReturns the built-in default template function.returns OgImageTemplateFn
module
templateDefault OG image template. Uses inline HTML/CSS for a flat, low-color brand card with t…

theme-renderer 10 symbols

fn
createTheme(config: { layouts: Record<string, ThemeComponent>; defaultLayout?: string; }): ThemeComponentCreates a theme with layout switching support.3 paramsreturns ThemeComponent1 example
fn
DefaultTheme({ children }: ThemeProps): JSXNodeDefault theme component. A minimal theme that renders page content with basic styling.1 paramreturns JSXNode
fn
generateTypes(pages: PageData[], outDir: string): Promise<void>Generates TypeScript type definitions from page frontmatter.2 paramsreturns Promise<void>
interface
PageDataPage data for rendering.9 members
fn
renderAllPages(pages: PageData[], options: ThemeRenderOptions): Promise<Map<string, string>>Renders all pages and generates type definitions.2 paramsreturns Promise<Map<string, string>>
fn
renderPage(page: PageData, options: ThemeRenderOptions): stringRenders a page using the theme component.2 paramsreturns string
module
theme-rendererTheme Renderer for Static HTML Generation Renders JSX theme components to static HTML s…
type
ThemeComponent = (props: ThemeProps) => JSXNodeTheme component type.1 paramreturns JSXNode
interface
ThemePropsProps passed to the theme component.1 member
interface
ThemeRenderOptionsTheme render options.6 members

theme-tokens 2 symbols

type
ThemeTokens = Record<string, string>Free-form --octc-* custom properties for themes that need more than the typed colors /…
fn
tokensToCss(light: ThemeTokens, dark: ThemeTokens): stringRenders light and dark token records as the three selectors the SSG runtime switches be…2 paramsreturns string

theme 31 symbols

fn
deepMerge<T extends Record<string, unknown>>(target: T, source: Partial<T>): TDeep merge two objects.2 paramsreturns T
variable
const defaultTheme: ThemeConfigDefault theme configuration. Based on the current ox-content SSG styles.
fn
defineTheme(config: ThemeConfig): ThemeConfigDefines a theme configuration with type checking.1 paramreturns ThemeConfig1 example
fn
expandExtendsChain(config: ThemeConfig): ThemeConfig[]Flattens one layer's extends chain into base-first order. The seen guard keeps a theme…1 paramreturns ThemeConfig[]
interface
LegacySocialLinksLegacy social links configuration.3 members
fn
mergeThemes(...themes: (ThemeConfig | ThemeConfig[])[]): ThemeConfigMerges multiple theme configurations. Later themes override earlier ones. Object fields…1 paramreturns ThemeConfig1 example
interface
NapiSocialLinksNAPI-compatible social links type.4 members
interface
NapiThemeColorsNAPI-compatible theme colors type.10 members
interface
NapiThemeConfigNAPI-compatible theme configuration type.11 members
interface
NapiThemeEmbedNAPI-compatible theme embed type.9 members
interface
NapiThemeEntryPageNAPI-compatible entry page theme type.1 member
interface
NapiThemeFontsNAPI-compatible theme fonts type.2 members
interface
NapiThemeFooterNAPI-compatible theme footer type.2 members
interface
NapiThemeHeaderNAPI-compatible theme header type.6 members
interface
NapiThemeLayoutNAPI-compatible theme layout type.3 members
interface
ResolvedThemeConfigResolved theme configuration (after merging with defaults).15 members
fn
resolveTheme(config?: ThemeConfig | ThemeConfig[]): ResolvedThemeConfigResolves a theme configuration by merging with its extends chain and defaults. An array…1 paramreturns ResolvedThemeConfig
interface
SocialLinkCustom social link.3 members
type
SocialLinkIcon = string | { svg: string }Custom social link icon.
type
SocialLinks = LegacySocialLinks | SocialLink[]Social links configuration.
module
themeTheme API for ox-content SSG Provides VitePress-like theming with default theme + custo…
interface
ThemeColorsTheme color configuration.10 members
interface
ThemeConfigComplete theme configuration.16 members
fn
themeCss(theme: ResolvedThemeConfig): stringToken blocks come first so a theme's own css stays the final word, and both land after…1 paramreturns string
interface
ThemeEmbedEmbedded HTML content for specific positions in the page layout.9 members
interface
ThemeEntryPageEntry page theme configuration.1 member
interface
ThemeFontsTheme font configuration.2 members
interface
ThemeFooterTheme footer configuration.2 members
interface
ThemeHeaderTheme header configuration.6 members
interface
ThemeLayoutTheme layout configuration.3 members
fn
themeToNapi(theme: ResolvedThemeConfig): NapiThemeConfigConverts resolved theme to the format expected by Rust NAPI.1 paramreturns NapiThemeConfig

transform 2 symbols

fn
rehypeGitHub(repoDataMap: Map<string, GitHubRepoData | null>, sourceDataMap: Map<string, GitHubSourceData | null>, options: Required<GitHubOptions>)Rehype plugin to transform GitHub components.3 params
fn
transformGitHub(html: string, repoDataMap?: Map<string, GitHubRepoData | null>, options?: GitHubOptions): Promise<string>Transform GitHub components in HTML.3 paramsreturns Promise<string>

transform 9 symbols

fn
extractImports(content: string): string[]Extracts imports from Markdown content. Supports importing components for interactive i…1 paramreturns string[]
fn
generateModuleCode(html: string, frontmatter: Record<string, unknown>, toc: TocEntry[], filePath: string, _options: ResolvedOptions): stringGenerates the JavaScript module code.5 paramsreturns string
fn
generateOgImageSvg(data: OgImageData, config?: OgImageConfig): Promise<string | null>Generates an OG image SVG using the Rust-based generator. This function uses the Rust N…2 paramsreturns Promise<string | null>
interface
JsTransformOptionsOptions for Rust-based Markdown transformation. Controls which Markdown extensions and…23 members
interface
NapiBindingsNAPI bindings for Rust-based Markdown processing. Provides access to compiled Rust func…6 members
interface
OgImageConfigOG image configuration.6 members
interface
OgImageDataOG image data for generating social media preview images.4 members
interface
SsgTransformOptionsSSG-specific transform options.3 members
module
transformMarkdown Transformation Engine This module handles the complete transformation pipeline…1 example

types 5 symbols

interface
OgImageOptionsOG image generation options (user-facing).6 members
type
OgImageTemplateFn = (props: OgImageTemplateProps) => string | Promise<string>Template function that receives page metadata and returns an HTML string.1 paramreturns string | Promise<string>
interface
OgImageTemplatePropsProps passed to OG image template functions.6 members
interface
ResolvedOgImageOptionsResolved OG image options with all defaults applied.6 members
module
typesType definitions for Chromium-based OG image generation.

types 73 symbols

interface
AttrsOptionsOptions for markdown-it-attrs style attribute blocks. Attribute blocks let authors atta…1 member
interface
BuiltinEmbedOptionsBuilt-in embed configuration.8 members
interface
BuiltinPmOptionsOptions for the package-manager install-tab transform.1 member
type
CodeAnnotationKind = "highlight" | "warning" | "error"Supported line annotation kinds for code blocks.
interface
CodeAnnotationsOptionsOpt-in code annotation configuration.3 members
type
CodeAnnotationSyntax = "attribute" | "vitepress" | "both"Supported code annotation syntaxes.
interface
CodeBlockLintOptionsOptions for linting fenced code blocks during Markdown transforms. These checks are int…4 members
interface
CodeBlockTypecheckOptionsOptions for type-checking TypeScript and TSX fenced code blocks. Type-checking writes m…4 members
interface
CodeImportOptionsOptions for importing source snippets into code fences. The transform resolves <<< impo…1 member
interface
CollectionEntryQueryable Markdown collection entry.13 members
type
CollectionIncludeField = "body" | "html" | "toc"Extra payload fields embedded into collection entries. Keep this list small for large s…
interface
CollectionManifestGenerated collection manifest.1 member
interface
CollectionOptionsCollection source configuration.2 members
type
CollectionsOptions = Record<string, CollectionOptions | string | readonly string[]>Top-level collection definitions.
interface
DocEntryA single documentation entry extracted from source. Entries represent top-level declara…14 members
interface
DocMemberA member belonging to a class, interface, type alias, or enum entry.16 members
type
DocsEntryPoint = string | { path: string; name?: string }Public API entry point for grouped documentation.
interface
DocsOptionsOptions for source documentation generation. The generator extracts JSDoc/TSDoc comment…33 members
interface
DocsSummarySummary counts emitted with generated documentation data.7 members
interface
DocsTestOptionsOptions for extracting fenced examples into docs-as-tests fixtures. The extractor colle…2 members
interface
EditThisPageOptionsOptions for appending an "edit this page" link. The generated link points at the source…4 members
interface
EmojiShortcodeOptionsOptions for expanding :shortcode: emoji aliases. The transform replaces recognized shor…1 member
interface
EntryPageConfigEntry page frontmatter configuration.3 members
interface
ExtractedDocsExtracted documentation for a single file.6 members
interface
FeatureConfigFeature card for entry page.5 members
interface
GeneratedDocsDataMachine-readable payload emitted alongside generated docs.4 members
interface
HeroActionHero section action button.3 members
interface
HeroConfigHero section configuration for entry page.6 members
interface
HeroImageHero section image configuration.6 members
interface
HeroNoticeHero notice configuration.2 members
interface
I18nOptionsi18n (internationalization) options. i18n is opt-in because it changes routing and buil…7 members
interface
LocaleConfigLocale configuration. Locales define the routing and display metadata used by the i18n…3 members
interface
MarkdownNodeMarkdown AST node (simplified for TypeScript).4 members
interface
MarkdownTransformerCustom AST transformer.2 members
interface
NavItemNavigation item for sidebar navigation.3 members
interface
OgImageOptionsOG image generation options. Uses Chromium-based rendering with customizable templates.6 members
interface
OxContentOptionsOptions for the core oxContent() Vite plugin. The top-level options describe where cont…38 members
interface
ParamDocParameter documentation.5 members
interface
ResolvedAttrsOptionsResolved attrs transform options.1 member
interface
ResolvedBuiltinEmbedOptionsResolved built-in embed configuration.8 members
interface
ResolvedCodeAnnotationsOptionsResolved code annotation configuration.4 members
interface
ResolvedCodeBlockLintOptionsResolved code-block lint options.5 members
interface
ResolvedCodeBlockTypecheckOptionsResolved code-block type-check options.5 members
interface
ResolvedCodeImportOptionsResolved code-import transform options.2 members
interface
ResolvedCollectionOptionsResolved collection definition.3 members
interface
ResolvedCollectionsOptionsResolved collection options.2 members
interface
ResolvedDocsEntryPointResolved public API entry point.2 members
interface
ResolvedDocsOptionsResolved docs options with all defaults applied.33 members
interface
ResolvedDocsTestOptionsResolved docs-as-tests extraction options.3 members
interface
ResolvedEditThisPageOptionsResolved edit-link transform options.5 members
interface
ResolvedEmojiShortcodeOptionsResolved emoji-shortcode transform options.2 members
interface
ResolvedI18nOptionsResolved i18n options with all defaults applied.7 members
interface
ResolvedOgImageOptionsResolved OG image options with all defaults applied.6 members
interface
ResolvedOptionsResolved options with all defaults applied.38 members
interface
ResolvedSanitizeOptionsResolved sanitize transform options.4 members
interface
ResolvedSearchOptionsResolved search options.5 members
interface
ResolvedSsgOptionsResolved SSG options.16 members
interface
ResolvedWikiLinkOptionsResolved wiki-link transform options.2 members
interface
ReturnDocReturn type documentation.2 members
interface
SanitizeOptionsOptions for sanitizing rendered HTML. Sanitization happens after Markdown is rendered t…3 members
interface
ScopedSearchQueryParsed search query with optional scope prefixes.2 members
interface
SearchDocumentSearch document structure.6 members
interface
SearchOptionsOptions for full-text search. Search indexes are built from Markdown content at build t…5 members
interface
SearchResultSearch result structure.7 members
interface
SsgNavigationGroupNavigation group for SSG sidebar rendering.2 members
interface
SsgNavigationItemNavigation item for SSG sidebar rendering.3 members
interface
SsgOptionsStatic Site Generation options. These options control the HTML files emitted at build t…16 members
interface
ThrowsDocException/error documentation.2 members
interface
TocEntryTable of contents entry.4 members
interface
TransformContextTransform context passed to transformers.3 members
interface
TransformResultTransform result.5 members
module
typesType definitions for @ox-content/vite-plugin
interface
WikiLinkOptionsOptions for expanding Obsidian-style wiki links. The transform accepts [target] and [ta…1 member

vitepress 5 symbols

fn
convertVitePressNav(nav: VitePressNavItem[]): SsgNavigationGroup[]Converts VitePress top navigation into ox-content sidebar groups. This is used as a fal…1 paramreturns SsgNavigationGroup[]
fn
convertVitePressSidebar(sidebar: VitePressSidebar): SsgNavigationGroup[]Converts a VitePress sidebar config into ox-content navigation groups. Nested VitePress…1 paramreturns SsgNavigationGroup[]
fn
fromVitePressConfig(config: VitePressConfig, overrides: OxContentOptions = {}): OxContentOptionsCreates ox-content plugin options from an existing VitePress config.2 paramsreturns OxContentOptions
fn
generateVitePressMigrationConfig(config: VitePressConfig, overrides: OxContentOptions = {}, options: GenerateVitePressMigrationConfigOptions = {}): stringGenerates a TypeScript module exporting migrated ox-content options. This is used by th…3 paramsreturns string
fn
normalizeVitePressFrontmatter(frontmatter: Record<string, unknown>): Record<string, unknown>Normalizes VitePress-specific frontmatter into ox-content's entry-page shape.1 paramreturns Record<string, unknown>

youtube 3 symbols

fn
extractVideoId(input: string): string | nullExtract YouTube video ID from various URL formats.1 paramreturns string | null
fn
transformYouTube(html: string, options?: YouTubeOptions): Promise<string>Transform YouTube components in HTML.2 paramsreturns Promise<string>
module
youtubeYouTube Plugin - Privacy-enhanced iframe embedding Transforms <YouTube> components into…