API Documentation#

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

128 modules 793 symbols 330 functions 300 interfaces 40 types 26 variables 97 modules 635 parameters 1618 members 327 returns 20 examples 2 deprecated

Modules#

api 6 symbols

fn
fetchGitHubResource(resource: GitHubResourceRef, options: Required<GitHubOptions>): Promise<GitHubResourceData | null>Fetch public GitHub issue, pull request, commit, discussion, or gist metadata.2 paramsreturns Promise<GitHubResourceData | null>
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
prefetchGitHubResources(resources: GitHubResourceRef[], options?: GitHubOptions): Promise<Map<string, GitHubResourceData | null>>Pre-fetch all GitHub resource cards.2 paramsreturns Promise<Map<string, GitHubResourceData | 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>>

apply-permalinks 5 symbols

module
apply-permalinksApplies resolved permalinks / cascade to SSG pages and collection entries.
fn
applyCollectionRoutes(manifest: CollectionManifest, permalinks?: ResolvedPermalinksOptions | null, cascade?: ResolvedCascadeOptions | null): { manifest: CollectionManifest; errors: string[] }Rewrites collection path / stem / inherited frontmatter.3 paramsreturns object
fn
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.9 paramsreturns object
fn
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.3 paramsreturns T[]
interface
SsgRoutablePageSSG page shape that can have its routePaths rewritten.3 members

attributes 3 symbols

fn
collectGitHubRepos(html: string): Promise<string[]>Collect all GitHub repos from HTML for pre-fetching.1 paramreturns Promise<string[]>
fn
collectGitHubResources(html: string): Promise<GitHubResourceRef[]>Collect all GitHub issue, pull request, commit, discussion, and gist refs.1 paramreturns Promise<GitHubResourceRef[]>
fn
collectGitHubSources(html: string): Promise<GitHubSourceRef[]>Collect all GitHub source references from HTML for pre-fetching.1 paramreturns Promise<GitHubSourceRef[]>

block-structure 2 symbols

fn
blockEmbedTags(): Promise<ReadonlySet<string>>Every tag whose embed is a block, taken from the registry rather than copied. A hand-ke…returns Promise<ReadonlySet<string>>
variable
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-date 1 symbol

module
blog-feed-datePublication dates from RSS / Atom items.

blog-feed-fetch 2 symbols

module
blog-feed-fetchBuild-time fetch of configured blog feeds. Never used for document URLs.
fn
installBlogFeedNetwork(network: BlogFeedNetwork): voidTest hook. Production builds leave this empty.1 paramreturns void

blog-feed-parse 1 symbol

module
blog-feed-parseRSS 2.0 / Atom 1.0 item extraction. HTML documents are rejected.

blog-feed-url 2 symbols

module
blog-feed-urlSafe-URL checks for configured external blog feeds.
variable
const CONTROL_CHARS = /[\n\r\t\0]/Safe-URL checks for configured external blog feeds.

blog-feeds 1 symbol

module
blog-feedsLoad, normalize, and merge configured external blog feeds.

blog-html 3 symbols

module
blog-htmlEscaped blog index, tag, archive, and post-meta HTML.
interface
BlogSourcePageOne listed post considered for blog surfaces.6 members
fn
isSafeBlogUrl(value: string): booleanhttps: or a same-origin path starting with / but not //.1 paramreturns boolean

blog-options 2 symbols

module
blog-optionsBlog option resolution.
fn
resolveBlogCollectionName(requested: string | undefined, collectionNames: readonly string[]): string | undefinedPicks a collection named blog, else the only configured collection. An explicit name al…2 paramsreturns string | undefined

blog-pages 4 symbols

fn
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.11 paramsreturns Promise<void>
module
blog-pagesGenerated blog index, tag, and archive pages.
interface
BlogGeneratedPageSynthetic page passed back to generateHtmlPage.5 members
fn
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.1 paramreturns object

blog-posts 1 symbol

module
blog-postsBlog post selection, tags, authors, and dates.

blog-reading 2 symbols

module
blog-readingDeterministic blog reading-time estimates.
variable
const LATIN_WORDS_PER_MINUTE = 200Deterministic blog reading-time estimates.

blog 1 symbol

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

browser 6 symbols

module
browserChromium browser session with automatic cleanup via Explicit Resource Management. Usage…
interface
OgBrowserPool extends AsyncDisposableA set of independent sessions, closed together.1 member
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>
fn
openBrowserPool(size: number): Promise<OgBrowserPool | null>Opens up to size independent browsers. Rendering does not parallelize inside one browse…1 paramreturns Promise<OgBrowserPool | null>
interface
PooledPageA pooled page and the public directory its route handler was set up for.2 members

cache 5 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
isCached(cacheDir: string, key: string): Promise<boolean>Whether a cached PNG exists, without reading it. Deciding whether the browser has to st…2 paramsreturns Promise<boolean>
fn
writeCache(cacheDir: string, key: string, png: Buffer): Promise<void>Writes a PNG buffer to the cache.3 paramsreturns Promise<void>

citations 1 symbol

fn
isLinkLabel(markdown: string, match: RegExpMatchArray): booleanA bracketed span that a destination or reference immediately follows is a Markdown link…2 paramsreturns boolean

collection-asset-html 1 symbol

fn
rewriteCollectionAssetUrls(input: RewriteCollectionAssetUrlsInput): RewriteCollectionAssetUrlsResultRewrites host-rendered HTML references from collection aliases to their content-address…1 paramreturns RewriteCollectionAssetUrlsResult

collection-assets 7 symbols

interface
CollectionAssetInputOne collection file and the public URLs that should expose it.2 members
interface
CollectionAssetManifestA reusable asset plan for a custom host's build writer and development middleware. Sour…1 member
interface
CollectionAssetManifestEntryA source file, its normalized aliases, and its content-addressed URL.3 members
fn
createCollectionAssetsMiddleware(manifest: CollectionAssetManifest): AssetMiddlewareCreate Connect-compatible middleware that serves planned aliases and their content-addr…1 paramreturns AssetMiddleware
fn
planCollectionAssets(input: PlanCollectionAssetsInput): Promise<CollectionAssetManifest>Hash collection files and normalize their public aliases without taking over the host r…1 paramreturns Promise<CollectionAssetManifest>
interface
PlanCollectionAssetsInputInputs for a content-addressed collection asset manifest.3 members
fn
writeCollectionAssets(input: WriteCollectionAssetsInput): Promise<WriteCollectionAssetsResult>Write each content-addressed target once, then materialize its aliases with hard links…1 paramreturns Promise<WriteCollectionAssetsResult>

contributors 2 symbols

module
contributorsOpt-in git contributor list helpers. Resolution and ignore filtering live here. git log…
fn
resolveContributorsOption(value: boolean | ContributorsOptions | undefined): ResolvedContributorsResolves ssg.contributors with defaults. false / omitted stays off. true enables names…1 paramreturns ResolvedContributors

cross-reference-html 3 symbols

module
cross-reference-htmlThe escaping and prose-scanning helpers the citation pass still needs. The cross-refere…
variable
const PROTECTED_TEXT_RE = /|<(pre|code|script|style|textarea|a)\b[\s\S]*?<\/\1>/giThe escaping and prose-scanning helpers the citation pass still needs. The cross-refere…
fn
transformText(html: string, replacer: (text: string) => string): stringRuns replacer over every stretch of prose, skipping verbatim elements.2 paramsreturns string

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.5 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, localePages: Array<{ path: string; href: string }>, hmr: boolean): Promise<string>Render a single markdown page to full HTML.8 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 7 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
generateOpenApiDocs(options: ResolvedDocsOptions, root = process.cwd()): GeneratedOpenApiDocsGenerates Markdown documentation from local OpenAPI 3.0/3.1 files.2 paramsreturns GeneratedOpenApiDocs
fn
resolveDocsOptions(options: false): falseResolves docs options with defaults.1 paramreturns false
fn
writeDocs(docs: Record<string, string>, outDir: string, extractedDocs?: ExtractedDocs[], options?: ResolvedDocsOptions, extraNav: DocsNavigationItem[] = []): Promise<void>Writes generated documentation to the output directory.5 paramsreturns Promise<void>

document-imports 1 symbol

module
document-importsResolve MDX component imports relative to the document that declared them. Only ./ and…

document-islands 1 symbol

module
document-islandsCombine document-local import resolution with MDX island discovery.

embed-transform 4 symbols

module
embed-transformReserve first-party embed components so MDX island lowering cannot swallow them. Rust s…
variable
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…
variable
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…
fn
restoreReservedBuiltinIslands(html: string, localNames?: Iterable<string>): stringReplace reserved built-in islands with the original HTML tags so embed transforms can s…2 paramsreturns string

environment 7 symbols

fn
createEnvironmentPlugins(options: ResolvedOptions)Environment plugin factory. Creates plugins specific to the Markdown environment.1 param
fn
createMarkdownEnvironment(options: ResolvedOptions, runtime: OxContentJavaScriptRuntime = detectJavaScriptRuntime()): EnvironmentOptionsCreates the Markdown processing environment configuration. This environment is used for…2 paramsreturns EnvironmentOptions1 example
fn
createTransformOptions(ctx: EnvironmentTransformContext, options: ResolvedOptions): ResolvedOptionsCreates environment-aware transform options.2 paramsreturns ResolvedOptions
fn
detectJavaScriptRuntime(): OxContentJavaScriptRuntimeDetects the runtime that is executing Vite.returns OxContentJavaScriptRuntime
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

feed-date 1 symbol

fn
parseDate(value: string | undefined): ParsedDate | undefinedParse a feed date: epoch seconds, epoch milliseconds, or a civil date-time with an opti…1 paramreturns ParsedDate | undefined

feed-format 1 symbol

module
feed-formatShapes the feed pipeline passes between item selection and the native renderer. The bod…

feeds-native 3 symbols

interface
FeedChannelExtrasChannel fields the formats emit when the standard has a matching slot.4 members
module
feeds-nativeBridges the resolved feed inputs onto generateFeedBodies. The TypeScript renderer this…
fn
nativeItem(item: FeedEntry): Record<string, unknown>FeedEntry carries the date already parsed into UTC components; the native side takes th…1 paramreturns Record<string, unknown>

feeds 6 symbols

module
feedsOpt-in RSS / Atom / JSON Feed helpers. Bodies come from oxcontentssg::generate_feeds…
interface
FeedsRenderInputInputs for rendering feed bodies.9 members
interface
FeedsRenderResultRendered feed bodies, or a skip warning.4 members
fn
generateFeeds(input: FeedsRenderInput): FeedsRenderResultBuilds RSS / Atom / JSON Feed bodies without writing files.1 paramreturns FeedsRenderResult
fn
resolveFeedCollectionName(requested: string | undefined, collectionNames: readonly string[]): string | undefinedPicks content, else the first configured collection name.2 paramsreturns string | undefined
fn
resolveFeedsOptions(value: boolean | FeedsOptions | undefined): ResolvedFeedsOptionsResolves feeds with defaults. false / omitted stays off. true enables all three formats…1 paramreturns ResolvedFeedsOptions

header-chrome 10 symbols

module
header-chromeOpt-in header nav, announcement, and per-page chrome helpers.
interface
HeaderNavItemHeader nav link or dropdown.3 members
type
LocaleLabel = string | Record<string, string>Plain label or locale map ({ en: "Guide", ja: "ガイド" }).
interface
PageChromeFlagsPer-page frontmatter chrome flags. false hides that region.7 members
fn
parsePageChromeFlags(frontmatter: Record<string, unknown>): PageChromeFlagsReads hide flags from frontmatter. Non-boolean values are ignored.1 paramreturns PageChromeFlags
interface
ResolvedHeaderNavItemNav item after locale maps are flattened to strings.3 members
fn
resolveHeaderNavItems(items: HeaderNavItem[] | undefined, locale?: string, defaultLocale?: string): ResolvedHeaderNavItem[] | undefinedResolves locale maps so NAPI always receives string labels.3 paramsreturns ResolvedHeaderNavItem[] | undefined
fn
resolveLocaleLabel(text: LocaleLabel, locale?: string, defaultLocale?: string): stringPicks the exact locale, its language, the default locale, then the first non-empty own…3 paramsreturns string
fn
resolvePageChromeOption(value: boolean | Record<string, unknown> | undefined): booleanfalse or omitted stays off. true or {} enables default flag reading.1 paramreturns boolean
interface
ThemeAnnouncementAnnouncement bar. Text is escaped; no raw HTML slot.3 members

highlight-native 6 symbols

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 the per-block wal…
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
interface
NativeDocumentWhat highlightDocumentNatively produced for a page.3 members
interface
PendingBlockA block the native pass left unhighlighted (no grammar).2 members

highlight 4 symbols

module
highlightSyntax highlighting with the native tree-sitter engine. Markup uses <pre class="ox-high…
fn
highlightCode(html: string): Promise<string>Apply native tree-sitter highlighting to HTML. Tries the document pass first. If that p…1 paramreturns Promise<string>
fn
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…2 paramsreturns Promise<string>
fn
rehypeNativeHighlight()Per-block walk used when the native document pass cannot read the markup. Unknown langu…

hosted-module 1 symbol

fn
embedSearchJson(value: unknown): stringJSON-embeds a value so it stays inert inside a script tag.1 paramreturns string

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

icons-css 1 symbol

module
icons-cssResolve Iconify JSON collections and emit CSS-mask rules. Collections come from install…

icons 3 symbols

module
iconsOpt-in self-hosted Iconify CSS for used and safelisted icons. Collection lookup stays o…
fn
renderSelfHostedIconsCss(input: RenderSelfHostedIconsCssOptions): Promise<RenderSelfHostedIconsCssResult>Render resolved icon CSS. Missing collections or names become errors.1 paramreturns Promise<RenderSelfHostedIconsCssResult>
fn
writeSelfHostedIcons(input: WriteSelfHostedIconsOptions): Promise<WriteSelfHostedIconsResult>Copy resolved icon CSS into outDir. Missing collections or names become errors.1 paramreturns Promise<WriteSelfHostedIconsResult>

index 3 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

index 1 symbol

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

index 22 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
defaultConcurrency(): numberHow many pages to render at once when the caller does not say. Rendering was serial by…returns number
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
KeyedPageEntry extends OgImagePageEntryA page entry with its cache key computed once.1 member
fn
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…3 paramsreturns Promise<Result[]>
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: KeyedPageEntry, templateFn: OgImageTemplateFn, options: ResolvedOgImageOptions, cacheDir: string, session: OgBrowserSession, publicDir?: string): Promise<OgImageResult>Renders a single page to PNG, with cache support.6 paramsreturns Promise<OgImageResult>
fn
renderSingleSatoriPage(entry: KeyedPageEntry, templateFn: OgImageTemplateFn, options: ResolvedOgImageOptions, cacheDir: string, root: string): Promise<OgImageResult>Renders a single page to PNG using Satori, with cache support.5 paramsreturns Promise<OgImageResult>
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: KeyedPageEntry[], cacheDir: string): Promise<OgImageResult[] | null>Serves every page from cache when all of them are present. The probe is an existence ch…2 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
fn
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…3 paramsreturns KeyedPageEntry[]

index 6 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
TransformAllOptions extends MediaEmbedOptionsTransform all plugin components in HTML. Call this during SSG build to process all plug…9 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; /** * 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.2 paramsreturns Promise<string>
variable
const TYPESCRIPT_ONLY_EMBED_TAGS = ["GitHub", "OgCard", "Reddit", "YouTube", "NotByAI"] as constEmbed tags this package owns, which the Rust provider registry cannot name. Everything…

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

island-codegen 1 symbol

module
island-codegenEmit static component imports for framework Markdown modules. Document-local bindings w…

island-ssr 2 symbols

module
island-ssrOptional adapter-side island SSR. Framework plugins may supply renderIsland to replace…
type
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…4 paramsreturns string | Promise<string>

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.4 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

locale-nav 3 symbols

module
locale-navRewrites default-theme nav hrefs to the current locale sibling when it exists.
fn
localizeHeaderNavItems(items: HeaderNavItem[] | undefined, options: LocalizeNavOptions): HeaderNavItem[] | undefinedResolves header labels and rewrites link values the same way as the sidebar.2 paramsreturns HeaderNavItem[] | undefined
fn
localizeNavGroups<T extends LocalizableNavGroup>(groups: T[], options: LocalizeNavOptions): T[]Resolves authored sidebar label maps and prefixes hrefs/paths with the current locale w…2 paramsreturns T[]

locale-switcher 2 symbols

fn
resolveLocaleSwitcherOption(value: boolean | Record<string, unknown> | undefined): booleanResolves ssg.localeSwitcher. Omitted / false stay off. true or an object enables the co…1 paramreturns boolean
interface
SsgLocalePathSibling page or locale-root href for one locale in the default-theme switcher.3 members

markdown-source 15 symbols

fn
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.6 paramsreturns Promise<Map<string, MarkdownSourceIndexEntry>>
fn
injectMarkdownSourceAlternate(html: string, href: string): stringInserts <link rel="alternate" type="text/markdown"> before </head>.2 paramsreturns string
fn
isMarkdownSourceRequest(pathname: string): booleanTrue when the request pathname is a .md companion URL.1 paramreturns boolean
module
markdown-sourceOpt-in Markdown source companions written beside generated HTML. Copies already-read so…
fn
markdownSourceHref(urlPath: string, base: string): string | undefinedPublic companion href, including base. Always ends in .md.2 paramsreturns string | undefined
fn
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.8 paramsreturns string | undefined
interface
MarkdownSourceIndexEntryOne entry in the dev-server companion index.2 members
fn
markdownSourceOutputPath(outDir: string, urlPath: string): string | undefinedFilesystem path for a companion, or undefined when it would escape outDir.2 paramsreturns string | undefined
interface
MarkdownSourcePageInputOne page that may receive a source companion.4 members
fn
parseSourceFrontmatter(source: string): Record<string, unknown>Frontmatter keys only — not a Markdown parse.1 paramreturns Record<string, unknown>
fn
resolveMarkdownSourceOptions(value: boolean | MarkdownSourceOptions | undefined): ResolvedMarkdownSourceOptionsResolves ssg.markdownSource with defaults. false / omitted stays off. true enables comp…1 paramreturns ResolvedMarkdownSourceOptions
fn
resolveMarkdownSourceRequest(pathname: string, index: ReadonlyMap<string, MarkdownSourceIndexEntry>): MarkdownSourceIndexEntry | undefinedLooks up a companion after the site base has been stripped.2 paramsreturns MarkdownSourceIndexEntry | undefined
fn
shouldPublishMarkdownSource(frontmatter: Record<string, unknown>, publishState?: ResolvedPublishStateOptions): booleanWhether this page may publish a companion. Draft and unlisted source is never emitted.…2 paramsreturns boolean
fn
writeMarkdownSourceFiles(input: WriteMarkdownSourceFilesInput): Promise<{ files: string[]; errors: string[] }>Writes enabled companions from already-read source bytes.1 paramreturns Promise<{ files: string[]; errors: string[] }>
interface
WriteMarkdownSourceFilesInputInputs for writing companions next to generated HTML.5 members

markdown-tables 1 symbol

fn
enhanceMarkdownTables(root?: ParentNode, options: MarkdownTableEnhancementOptions = {}): numberMakes overflowing Markdown tables keyboard-scrollable without wrapping or replacing the…2 paramsreturns number

markdown 2 symbols

fn
isMdxFilePath(filePath: string): booleanReturns true when a resource id points at an MDX source file.1 paramreturns boolean
fn
resolveMdxForFilePath(filePath: string, configured?: boolean): booleanExplicit configuration wins; otherwise MDX follows the source extension.2 paramsreturns boolean

math-assets 5 symbols

fn
copyKatexAssets(outDir: string, formats: KatexFontFormats = "woff2"): Promise<string[]>Copies katex.min.css and the requested font formats into the SSG output. Returns an emp…2 paramsreturns Promise<string[]>
fn
createKatexAssetsPlugin(): PluginDev-server middleware that serves /_oxkatex__/* from katex/dist.returns Plugin
variable
const FONT_FORMATS = { woff2: [".woff2"], all: [".woff2", ".woff", ".ttf"] } as constFont formats KaTeX ships, newest first.
type
KatexFontFormats = keyof typeof FONT_FORMATSWhich of KaTeX's font formats to emit.
module
math-assetsServe and copy KaTeX CSS/fonts only when the optional katex package exists.

math 6 symbols

fn
decodeHtmlAttr(value: string): stringDecodes the attribute back to the TeX the author wrote. The placeholder is escaped by R…1 paramreturns string
module
mathBuild-time KaTeX rendering for opt-in $…$ / $$…$$ math. KaTeX is an optional peer. Site…
type
MathErrorPolicy = "literal" | "error" | "render"What to do with a $…$ run KaTeX cannot parse.
interface
MathRenderFailureOne $…$ run KaTeX refused, for the caller to report.3 members
fn
renderKatexMath(html: string, onError: MathErrorPolicy = "literal", failures?: MathRenderFailure[]): Promise<string>Replaces rust ox-math placeholders with static KaTeX HTML. Leaves the escaped TeX fallb…3 paramsreturns Promise<string>
fn
resolveKatexDist(): string | nullDirectory that contains katex.min.css and fonts/, or null.returns string | null

mdx-islands 7 symbols

fn
collectMdxIslandNamesFromHtml(html: string): string[]Collect data-ox-island names from Rust-rendered HTML. Used when an AST walk is unavaila…1 paramreturns string[]
fn
collectMdxJsxNamesFromAst(ast: unknown): string[]Collect named MDX JSX tags from a parsed mdast tree (JSON from NAPI parse()). Fragments…1 paramreturns string[]
type
ComponentRegistry = Readonly<Record<string, unknown>> | ReadonlyMap<string, unknown> | Iterable<string>Global component map: object, Map, or name list.
fn
discoverRegisteredMdxComponents(input: DiscoverRegisteredMdxComponentsInput): Promise<string[]>Resolve registered island names for an MDX document. Prefers a NAPI parse() AST walk. F…1 paramreturns Promise<string[]>
fn
intersectHydratableComponentNames(names: Iterable<string>, components: ComponentRegistry, localNames?: Iterable<string>): string[]Keep names that are either globally registered or document-local bindings.3 paramsreturns string[]
fn
intersectRegisteredComponentNames(names: Iterable<string>, components: ComponentRegistry): string[]Keep names that exist on the global component map, in first-seen order.2 paramsreturns string[]
module
mdx-islandsDiscover registered MDX islands from the mdast tree or rendered HTML. Framework plugins…

media-marker 2 symbols

fn
hasMediaMarker(html: string): Promise<boolean>True when the document contains any tag the transform could rewrite. The list comes fro…1 paramreturns Promise<boolean>
variable
const TYPESCRIPT_ONLY_TAGS = ["reddit"] as constProviders that live in this package rather than the Rust registry, so the registry cann…

media 1 symbol

fn
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…1 paramreturns void

mermaid-protect 6 symbols

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

not-found 8 symbols

variable
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.
fn
isNotFoundSourceFile(filePath: string, srcDir: string, options?: ResolvedNotFoundOptions): booleanTrue when filePath is the enabled not-found source.3 paramsreturns boolean
module
not-foundOpt-in custom 404 page helpers. Resolution and path rules live here. The Vite plugin wr…
fn
notFoundSearchDocumentId(source: string): stringSearch document id for a not-found source path.1 paramreturns string
fn
notFoundSearchExcludeIds(options?: ResolvedNotFoundOptions): string[]Search document ids that must not be indexed when the feature is on.1 paramreturns string[]
fn
resolveNotFoundOptions(value: boolean | NotFoundOptions | undefined): ResolvedNotFoundOptionsResolves ssg.notFound with defaults. false / omitted stays off. true enables 404.md → 4…1 paramreturns ResolvedNotFoundOptions
fn
resolveNotFoundOutputPath(outDir: string, output: string): stringAbsolute output path, confined to outDir.2 paramsreturns string
fn
resolveNotFoundSourcePath(srcDir: string, source: string): stringAbsolute source path, confined to srcDir.2 paramsreturns string

og-viewer 1 symbol

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

ogp 1 symbol

module
ogpOGP Card Plugin - Link card embedding Transforms <OgCard> components into static link p…

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

page-head 3 symbols

interface
HeadInputBuild-time page-head input. Unhead-shaped, no client runtime. Unknown keys such as twit…18 members
type
HeadValidationMode = false | "off" | "warn" | "strict"How invalid head descriptors are reported.
fn
renderHead(input: HeadInput): RenderedHeadResolve descriptors to escaped <head> markup. Build-time only.1 paramreturns RenderedHead

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>

parse 3 symbols

fn
decodeHtmlEntities(value: string): stringExpand the character references that show up in <meta> content. Metadata is markup, so…1 paramreturns string
fn
faviconUrl(html: string, pageUrl: string): string | undefinedThe site's own icon, never a third-party favicon lookup service. Routing every card thr…2 paramsreturns string | undefined
fn
resolveMetaUrl(value: string, pageUrl: string): string | undefinedResolve a URL taken from page metadata against the page it came from. Open Graph lets a…2 paramsreturns string | undefined

permalinks 8 symbols

fn
escapeAttribute(value: string): stringEscapes a value for use in an HTML attribute.1 paramreturns string
module
permalinksOpt-in permalink / slug routing and index frontmatter cascade. Resolution follows oxc…
fn
resolveCascadeOptions(value: boolean | CascadeOptions | undefined): ResolvedCascadeOptionsResolves cascade. false / omitted stays off. true / {} enables.1 paramreturns ResolvedCascadeOptions
interface
ResolvedRoutePageA page after cascade and optional permalink / slug rewriting.3 members
fn
resolvePageRoutes(input: { pages: readonly RoutePageInput[]; permalinks?: ResolvedPermalinksOptions | null; cascade?: ResolvedCascadeOptions | null; }): RouteResolveOutputApplies cascade (when on) then permalink / slug rewriting (when on). Collisions skip th…4 paramsreturns RouteResolveOutput
fn
resolvePermalinksOptions(value: boolean | PermalinksOptions | undefined): ResolvedPermalinksOptionsResolves permalinks. false / omitted stays off. true / {} enables.1 paramreturns ResolvedPermalinksOptions
interface
RoutePageInputOne page considered for cascade and permalink resolution.3 members
interface
RouteResolveOutputResolved pages plus collision / rejection errors.2 members

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>

provider-article-values 1 symbol

module
provider-article-valuesValue shaping for provider article cards: reading and writing tag attributes, and narro…

provider-disk-cache 5 symbols

module
provider-disk-cacheA cross-build cache for provider card metadata. Open Graph cards have had one of these…
interface
ProviderCacheEntry<T>What one cache file holds. null data is a remembered miss.4 members
fn
providerCacheFileName(key: string): stringA file name for a cache key. Hashed rather than escaped: a key carries a provider URL,…1 paramreturns string
fn
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…4 paramsreturns Promise<T | null | undefined>
fn
writeProviderCache<T>(cacheDir: string | null, key: string, data: T | null, cachedAt: number): Promise<void>Writes a value, replacing any existing entry atomically.4 paramsreturns Promise<void>

provider-failure 5 symbols

type
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…
fn
errorCode(error: Error): string | undefinedcause is where undici puts the syscall error; older runtimes use code.1 paramreturns string | undefined
variable
const OFFLINE_CODES = new Set([ "ENOTFOUND", "EAI_AGAIN", "ECONNREFUSED", "ENETUNREACH", "ENETDOWN", "EHOSTUNREACH", ])Node's fetch reports a missing network through cause.code.
variable
let offlineReported = falseAn offline build fails every lookup for the same reason, so it says so once. One line p…
module
provider-failureWhy a build-time embed lookup did not produce metadata. Every fetcher used to collapse…

publish-state 8 symbols

fn
classifyPublishState(frontmatter: Record<string, unknown>, options: ResolvedPublishStateOptions | undefined): { output: boolean; listed: boolean }Classifies one frontmatter object. Never throws.2 paramsreturns object
fn
filterNavGroups<T extends NavGroupLike>(groups: T[], hidden: ReadonlySet<string>): T[]Drops nav items that resolve to hidden (unpublished or unlisted) pages.2 paramsreturns T[]
fn
hiddenNavKeys(pages: readonly PublishStatePage[], listed: readonly PublishStatePage[]): Set<string>Keys used to match a page against generated nav items.2 paramsreturns Set<string>
interface
PartitionedPages<T>Split pages into production output vs listing surfaces.2 members
fn
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.2 paramsreturns PartitionedPages<T>
module
publish-stateOpt-in draft / unlisted / scheduled page classification.
interface
PublishStatePageOne page considered for publish-state filtering.4 members
fn
resolvePublishStateOptions(value: boolean | PublishStateOptions | undefined): ResolvedPublishStateOptionsResolves publishState with defaults. false / omitted stays off. true enables production…1 paramreturns ResolvedPublishStateOptions

pwa 8 symbols

fn
generatePwa(input: PwaRenderInput): PwaRenderResultBuilds manifest / service-worker bodies without writing files.1 paramreturns PwaRenderResult
fn
injectPwaPageTags(html: string, input: { options?: ResolvedPwaOptions | null; base?: string }): stringInjects rel=manifest (and the service-worker register script when offline) into a theme…4 paramsreturns string
module
pwaOpt-in web app manifest and conservative service worker. The Vite plugin writes those f…
interface
PwaRenderInputInputs for rendering PWA file bodies.4 members
interface
PwaRenderResultRendered PWA bodies, or a skip warning.3 members
fn
resolvePwaOptions(value: boolean | PwaOptions | undefined): ResolvedPwaOptionsResolves pwa with defaults. false / omitted stays off. true enables the manifest and of…1 paramreturns ResolvedPwaOptions
fn
writePwaFiles(input: WritePwaFilesInput): Promise<{ files: string[]; warning?: string }>Writes enabled PWA files into outDir.1 paramreturns Promise<{ files: string[]; warning?: string }>
interface
WritePwaFilesInput extends PwaRenderInputInputs for writing PWA files next to generated HTML.2 members

reader-chrome-options 2 symbols

interface
ReaderChromeOptionsPer-control flags for ssg.readerChrome. Omitted fields stay on when the feature itself…3 members
type
ResolvedReaderChrome = false | { copy: boolean; externalLinks: boolean; backToTop: boolean }Resolved reader chrome. false means no extra markup or JS.

reader-chrome 8 symbols

fn
applyReaderChromeHtml(html: string, input: ReaderChromeInput = true): stringApply the same native reader-chrome HTML transform used by the built-in SSG. This rewri…2 paramsreturns string
fn
readerChromeAttributes(input: ReaderChromeInput = true): Readonly<Record<string, "">>Root attributes consumed by the browser runtime.1 paramreturns Readonly<Record<string, "">>
fn
readerChromeCss(input: ReaderChromeInput = true): stringCSS shared by the built-in SSG and custom hosts.1 paramreturns string
fn
readerChromeScript(input: ReaderChromeInput = true): stringAuto-initializing script shared by the built-in SSG and custom hosts.1 paramreturns string
fn
renderReaderChromeAttributes(input: ReaderChromeInput = true): stringRender the root attributes as a leading-space HTML fragment. Useful in template strings…1 paramreturns string
fn
renderReaderChromeScriptTag(input: ReaderChromeInput = true): stringInline auto-init script for static hosts that do not bundle @ox-content/vite-plugin/rea…1 paramreturns string
fn
renderReaderChromeStyleTag(input: ReaderChromeInput = true): stringInline stylesheet tag for hosts that do not import @ox-content/vite-plugin/styles/reade…1 paramreturns string
fn
resolveReaderChromeInput(input: ReaderChromeInput = true): ResolvedReaderChromeResolve the public reader-chrome option shape. true mirrors ssg.readerChrome: true: cop…1 paramreturns ResolvedReaderChrome

redirect-provider 1 symbol

fn
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…2 paramsreturns object

redirects 13 symbols

fn
generateRedirectHtml(dest: string): stringStatic HTML redirect body. dest is escaped.1 paramreturns string
fn
isHostWildcardSource(from: string): boolean* is host-rule syntax (Netlify / Cloudflare), not a URL segment.1 paramreturns boolean
fn
isSafeDest(value: string): booleanSame-origin path: leading /, not //, and no scheme.1 paramreturns boolean
fn
normalizePath(value: string): string | nullStrips a trailing slash except for /. Unsafe values become null.1 paramreturns string | null
fn
planRedirectFiles(input: RedirectPlanInput): RedirectPlanPlans redirect HTML files without writing them.1 paramreturns RedirectPlan
interface
RedirectFilePlanOne planned static HTML redirect.4 members
interface
RedirectPageInputOne page that may declare aliases or a single redirect source.3 members
interface
RedirectPlanPlanned redirect files and optional host / JSON bodies.4 members
interface
RedirectPlanInputInputs for planning redirect files.3 members
module
redirectsOpt-in static redirects / aliases. HTML bodies follow oxcontentssg::generate_redirect…
fn
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…2 paramsreturns ResolvedRedirectsOptions
fn
writeRedirectFiles(input: WriteRedirectFilesInput): Promise<{ files: string[] }>Writes planned redirect HTML (and optional host files) into outDir.1 paramreturns Promise<{ files: string[] }>
interface
WriteRedirectFilesInputInputs for writing redirect files next to generated HTML.4 members

render-markdown 4 symbols

fn
createMarkdownProcessor(options: OxContentOptions = {}): MarkdownProcessorResolves public options once so custom ssg: false hosts can reuse the pipeline.1 paramreturns MarkdownProcessor
interface
MarkdownProcessorProcessor that resolves OxContentOptions once and renders many documents.1 member
module
render-markdownProgrammatic Markdown/MDX pipeline for hosts that do not import files through Vite.
fn
renderMarkdown(source: string, filePath: string, options: OxContentOptions = {}): Promise<TransformResult>Run the Vite plugin Markdown/MDX pipeline from public OxContentOptions. Returns structu…3 paramsreturns Promise<TransformResult>

renderer 4 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
routePublicDir(page: Page, publicDir: string): Promise<void>Serves local assets from publicDir for anything the card requests. Registered once per…2 paramsreturns Promise<void>
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

resolve-options 1 symbol

fn
resolveOptions(options: OxContentOptions): ResolvedOptionsResolves plugin options with defaults.1 paramreturns ResolvedOptions

resources-dedupe 4 symbols

fn
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…4 paramsreturns Promise<string>
fn
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…3 paramsreturns Promise<"link" | "copy">
module
resources-dedupeSite-wide content-addressed emit for identical page-resource bytes. Hashing streams the…
fn
rewriteToCanonicalUrl(originalSrc: string, canonicalPath: string): stringKeep leftover search/hash; drop consumed transform params.2 paramsreturns string

resources-html 2 symbols

variable
const RESOURCE_TAG = /<(?:img|video|audio|source|track|a)\b[^>]*>/giCollect local src, poster, and relevant href values from HTML tags.
module
resources-htmlCollect local src, poster, and relevant href values from HTML tags.

resources-image 1 symbol

module
resources-imageBuild-time PNG/JPEG pixel helpers for page resources. PNG is decoded and re-encoded for…

resources-jpeg 1 symbol

module
resources-jpegJPEG encode-only helpers for page resource transforms.

resources-process 1 symbol

module
resources-processPage-resource HTML rewriting and transform writes.

resources-write 1 symbol

module
resources-writeTransform cache writes for page resources.

resources 4 symbols

fn
isInsideRoot(root: string, candidate: string): booleanTrue when candidate stays inside root after resolve.2 paramsreturns boolean
fn
resolveResourcesOptions(value: boolean | ResourcesOptions | undefined): ResolvedResourcesOptionsResolves resources. Omitted / false stay off. true or {} enables defaults. An object en…1 paramreturns ResolvedResourcesOptions
fn
resourceCacheKey(sourcePath: string, mtimeMs: number, transform: ResourceTransform): stringCache key for a source file plus transform. Changing mtime or params produces a differe…3 paramsreturns string
module
resourcesOpt-in page-bundle resources and build-time image processing. A page directory is the b…

satori-renderer 1 symbol

fn
renderHtmlToPngWithSatori(source: string, options: ResolvedOgImageOptions, root: string): Promise<Buffer>Render an HTML string to PNG using Satori and resvg.3 paramsreturns Promise<Buffer>

search-filters 2 symbols

module
search-filtersLanguage and version filters for the default search dialog.
fn
searchDocumentLocale(path: string, localeCodes: readonly string[], defaultLocale: string, versionPrefixes: readonly string[] = []): stringResolves a document path to a locale code after stripping version prefixes.4 paramsreturns string

search-provider 5 symbols

fn
generateHostedSearchModule(options: ResolvedSearchOptions): stringClient runtime that queries the hosted HTTP adapter. Misconfigured hosted search emits…1 paramreturns string
fn
hasForbiddenSearchCredentialFields(options: object): booleanReturns true when the options object names a write or admin credential.1 paramreturns boolean
fn
resolveHostedSearchConfig(options: SearchOptions, env: NodeJS.ProcessEnv = process.env): HostedSearchConfig | nullResolves hosted credentials from config or env. Missing or forbidden keys fail closed a…2 paramsreturns HostedSearchConfig | null
module
search-providerOpt-in hosted search provider for virtual:ox-content/search. Local BM25 stays the defau…
fn
toLocalSearchRuntimeOptions(options: ResolvedSearchOptions)Runtime fields accepted by the native local BM25 module generator.1 param

search 8 symbols

fn
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…8 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>

section-index-html 5 symbols

fn
escapeSectionIndexHtml(value: string): stringEscapes text and attribute values in generated listing markup.1 paramreturns string
fn
isSafeSectionHref(value: string): booleanhttps:-free, same-origin or relative href. javascript: is rejected.1 paramreturns boolean
fn
renderSectionIndexHtml(title: string, items: readonly SectionIndexItem[], style: SectionIndexStyle): stringRenders the listing body. Titles are escaped; hostile hrefs are dropped.3 paramsreturns string
module
section-index-htmlSection-index listing HTML and href safety. Titles are escaped. javascript: / data: / v…
interface
SectionIndexItemOne child link on a generated section index.3 members

section-index-paths 1 symbol

module
section-index-pathsSection-index URL, title, and output-path helpers.

section-index 6 symbols

fn
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.10 paramsreturns Promise<void>
fn
resolveSectionIndexOptions(value: boolean | SectionIndexOptions | undefined): ResolvedSectionIndexOptionsResolves ssg.sectionIndex with defaults. false / omitted stays off. true enables card l…1 paramreturns ResolvedSectionIndexOptions
module
section-indexOpt-in generated section index pages. Resolution and directory walking live here. Listi…
interface
SectionIndexGeneratedPageSynthetic page passed back to generateHtmlPage.5 members
interface
SectionIndexSourcePageOne built page considered when deciding indexes and children.5 members
fn
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.1 paramreturns object

site-maps 9 symbols

fn
formatLastmod(timestampMs: number | undefined): string | undefinedUTC YYYY-MM-DD for W3C lastmod. Invalid or negative timestamps are dropped.1 paramreturns string | undefined
fn
generateSiteMaps(input: SiteMapsRenderInput): SiteMapsRenderResultBuilds sitemap / robots / llms bodies without writing files.1 paramreturns SiteMapsRenderResult
fn
resolveSiteMapsOptions(value: boolean | SiteMapsOptions | undefined): ResolvedSiteMapsOptionsResolves siteMaps with defaults. false / omitted stays off. true enables all three file…1 paramreturns ResolvedSiteMapsOptions
module
site-mapsOpt-in sitemap.xml / robots.txt / llms.txt helpers. Bodies come from oxcontentssg::ge…
interface
SiteMapPageInputOne page considered for crawl manifests.6 members
interface
SiteMapsRenderInputInputs for rendering crawl-manifest bodies.6 members
interface
SiteMapsRenderResultRendered crawl-manifest bodies, or a skip warning.4 members
fn
writeSiteMapFiles(input: WriteSiteMapFilesInput): Promise<{ files: string[]; warning?: string }>Writes enabled crawl manifests into outDir.1 paramreturns Promise<{ files: string[]; warning?: string }>
interface
WriteSiteMapFilesInputInputs for writing crawl manifests next to generated HTML.7 members

ssg-output-write 7 symbols

fn
resolveGitLastmod(filePath: string, root?: string): number | undefinedGit last-commit time for filePath in milliseconds. Same lookup buildSsg() uses for ssg.…2 paramsreturns number | undefined
module
ssg-output-writeWriters for composable SSG outputs. Custom hosts call these without buildSsg().
fn
writeMarkdownCompanions(input: WriteMarkdownSourceFilesInput): Promise<{ files: string[]; errors: string[] }>Write Markdown companions for host-rendered pages. Reuses writeMarkdownSourceFiles from…1 paramreturns Promise<{ files: string[]; errors: string[] }>
fn
writeResourceFiles(input: WriteResourceFilesInput): Promise<WriteResourceFilesResult>Fingerprint, rewrite, and emit page resources for host-rendered HTML. Uses the same res…1 paramreturns Promise<WriteResourceFilesResult>
interface
WriteResourceFilesInputInputs for writing fingerprinted page resources from host HTML.7 members
interface
WriteResourceFilesPageOne host-rendered page that may receive resource fingerprinting.3 members
interface
WriteResourceFilesResultRewritten host pages plus emitted resource paths.3 members

ssg-output 5 symbols

fn
planSsgOutputs(input: PlanSsgOutputsInput): SsgOutputPlanPlan resource, companion, feed, and sitemap outputs without rendering pages. ssg.enable…1 paramreturns SsgOutputPlan
interface
PlanSsgOutputsInputInputs for planning composable SSG outputs from host-rendered pages.9 members
interface
PlanSsgOutputsOptionsSame option objects oxContent() / buildSsg() accept. ssg.enabled is ignored.7 members
module
ssg-outputComposable SSG outputs for custom hosts that set ssg: false. Ox Content owns resource f…
interface
SsgOutputPlanPlanned writer inputs. Call the matching write* function for each feature.5 members

ssg 35 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 while retaining locale-map…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[], pagination = false, readerChrome: ResolvedReaderChrome = false, breadcrumbs = false, localeSwitcher = false, localePaths?: SsgLocalePath[], a11y: ResolvedA11y = false, team: ResolvedTeamOptions = { enabled: false, members: [] }, pageChrome: boolean = false, breadcrumbRootHref?: string, jsonLd: ResolvedJsonLd = false, siteUrl?: string, headValidation: false | "warn" | "strict" = false, defaultLocale?: string, iconsEnabled = false): Promise<string>Generates HTML page with navigation using Rust NAPI bindings.22 paramsreturns Promise<string>
fn
getHref(inputPath: string, srcDir: string, base: string, extension: string, routePrefix?: string): stringConverts a markdown file path to an href.5 paramsreturns string
fn
getOutputPath(inputPath: string, srcDir: string, outDir: string, extension: string, routePrefix?: string): stringConverts a markdown file path to its corresponding HTML output path.5 paramsreturns string
fn
getUrlPath(inputPath: string, srcDir: string, routePrefix?: string): stringConverts a markdown file path to a relative URL path.3 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
normalizeRoutePrefix(value?: string): string | undefinedNormalizes blog / /blog / /blog/ to blog. Empty or unsafe values stay off.1 paramreturns string | undefined
fn
parseSsgPagerOverride(value: unknown): SsgPagerOverride | undefinedParses prev / next frontmatter into a pager override.1 paramreturns SsgPagerOverride | undefined
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
fn
sitePathFromUrlPath(urlPath: string): stringTurns an SSG urlPath (guide or /) into a same-origin dest (/guide).1 paramreturns string
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.15 members
interface
SsgPagerOverrideFrontmatter override for one previous/next pager side.3 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, markdownSource?: string): ThemePageDataMaps an internal page result onto the theme renderer's page shape.2 paramsreturns 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>

taxonomies-html 2 symbols

module
taxonomies-htmlEscaped taxonomy HTML and confined output paths.
interface
TaxonomySourcePageOne built page considered for terms and related lists.5 members

taxonomies 7 symbols

fn
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.8 paramsreturns Promise<void>
fn
injectRelatedPages(pages: TaxonomySourcePage[], listed: readonly TaxonomySourcePage[], options?: ResolvedTaxonomiesOptions): voidAppends related-page HTML to source pages that share a listed term.3 paramsreturns void
fn
resolveTaxonomiesOptions(value: boolean | TaxonomiesOptions | undefined): ResolvedTaxonomiesOptionsResolves taxonomies with defaults. false / omitted stays off. true enables tags and cat…1 paramreturns ResolvedTaxonomiesOptions
module
taxonomiesOpt-in taxonomy term pages and related-page lists. Resolution and HTML live here. The V…
interface
TaxonomyGeneratedPageSynthetic page passed back to generateHtmlPage.5 members
fn
termSlug(term: string): string | undefinedStable URL slug for a frontmatter term. Returns undefined when the value cannot become…1 paramreturns string | undefined
fn
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.1 paramreturns object

team 2 symbols

fn
resolveTeamOptions(value: boolean | TeamOptions | undefined): ResolvedTeamOptionsResolves ssg.team with defaults. false / omitted stays off. true enables an empty membe…1 paramreturns ResolvedTeamOptions
module
teamOpt-in team / members page helpers. Resolution lives here. Member cards are rendered in…

template 4 symbols

fn
escapeHtml(str: string): stringEscapes HTML special characters.1 paramreturns string
fn
getDefaultSatoriTemplate(): OgImageTemplateFnReturns the built-in template for the Satori renderer. The Chromium template intentiona…returns OgImageTemplateFn
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-bootstrap 5 symbols

fn
applyThemeBootstrap(options: ThemeBootstrapOptions = {}): ThemeBootstrapStateApply the resolved theme state to the configured root element. Hosts can reuse this ins…1 paramreturns ThemeBootstrapState
fn
createThemeBootstrapScript(options: ThemeBootstrapOptions = {}): stringReturn the exact inline JavaScript body a static host can hash for CSP.1 paramreturns string
fn
renderThemeBootstrapScript(options: ThemeBootstrapOptions = {}, renderOptions: RenderThemeBootstrapScriptOptions = {}): stringRender an inline first-paint bootstrap tag. Use createThemeBootstrapScript() when a dep…2 paramsreturns string
fn
resolveThemeBootstrapState(storedPreference: string | null | undefined, prefersDark: boolean, options: ThemeBootstrapOptions = {}): ThemeBootstrapStateResolve a stored theme preference to the root state the bootstrap applies.3 paramsreturns ThemeBootstrapState
fn
setThemeBootstrapPreference(preference: ThemeBootstrapPreference, options: ThemeBootstrapOptions = {}): ThemeBootstrapStatePersist a preference and apply it with the same root contract as the bootstrap.2 paramsreturns ThemeBootstrapState

theme-fonts-acquire 1 symbol

module
theme-fonts-acquireResolve self-hosted faces from a local file / @fontsource directory or Google Fonts. Do…

theme-fonts 6 symbols

fn
cssFamilyName(family: string): stringCSS font-family identifier; quotes names that are not a single ident.1 paramreturns string
fn
flattenThemeFonts(fonts: ThemeFontsLike): { sans?: string; mono?: string } | undefinedFlatten object fonts so JsThemeFonts stays { sans?: string; mono?: string }.1 paramreturns { sans?: string; mono?: string } | undefined
fn
namedFontVarsCss(fonts: ThemeFontsLike): stringExtra --octc-font-* variables for fonts.named. Roles stay in Rust theme CSS.1 paramreturns string
module
theme-fontsOpt-in web-font objects for theme.fonts, plus SSG self-host emission. NAPI still receiv…
interface
ThemeWebFontUnoCSS-inspired family descriptor. The string stack form remains valid.11 members
fn
writeSelfHostedThemeFonts(options: WriteThemeFontsOptions): Promise<string[]>Copy self-hosted faces into outDir and write @font-face CSS.1 paramreturns Promise<string[]>

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.11 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 6 symbols

fn
expandExtendsChain(theme: ThemeTokenSource): ThemeTokenSource[]Flattens one layer's extends chain into base-first order, mirroring the SSG's own resol…1 paramreturns ThemeTokenSource[]
fn
renderThemeTokenCss(theme: ThemeTokenSource | ThemeTokenSource[], options: RenderThemeTokenCssOptions = {}): stringRenders a theme's --octc-* tokens as a standalone stylesheet. The built-in SSG emits th…2 paramsreturns string
interface
RenderThemeTokenCssOptionsOptions for renderThemeTokenCss.1 member
type
ThemeTokens = Record<string, string>Free-form --octc-* custom properties for themes that need more than the typed colors /…
interface
ThemeTokenSourceThe token-bearing shape of a theme. Declared structurally instead of importing ThemeCon…3 members
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 32 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.17 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).22 members
fn
resolveTheme(config?: ThemeConfig | ThemeConfig[]): ResolvedThemeConfigResolves a theme configuration by merging with its extends chain and defaults. An array…1 paramreturns ResolvedThemeConfig
interface
SidebarItemSidebar group or link, including recursively nested localized labels.5 members
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.23 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. sans and mono accept a CSS stack string or a web-font object.…3 members
interface
ThemeFooterTheme footer configuration.2 members
interface
ThemeHeaderTheme header configuration.6 members
interface
ThemeLayoutTheme layout configuration.3 members
fn
themeToNapi(theme: ResolvedThemeConfig, locale?: string, base?: string, iconsEnabled = false): NapiThemeConfigConverts resolved theme to the format expected by Rust NAPI.4 paramsreturns NapiThemeConfig

transform 2 symbols

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

transform 12 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[], 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 /…10 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…45 members
interface
NapiTransformResultWhat the native transform entry points return.7 members
interface
OgImageConfigOG image configuration.6 members
interface
OgImageDataOG image data for generating social media preview images.4 members
fn
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…6 paramsreturns Promise<NapiTransformResult>
interface
SsgTransformOptionsSSG-specific transform options.4 members
module
transformMarkdown Transformation Engine This module handles the complete transformation pipeline…1 example
variable
const UNHIGHLIGHTED_CODE_BLOCK = /<pre(?![^>]*ox-highlight)[^>]*><code class="language-/A <pre> that names a language but has not been highlighted yet.
fn
warnMathFailures(failures: MathRenderFailure[], filePath: string): voidReports every $…$ run KaTeX refused. Under the default policy the page keeps its prose,…2 paramsreturns void

types 9 symbols

interface
OgImageOptionsOG image generation options (user-facing).8 members
type
OgImageRenderer = "chromium" | "satori"OG image rendering backend.
interface
OgImageSatoriFontFont file loaded by the Satori renderer.4 members
type
OgImageSatoriFontWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900Font weight values supported by Satori.
interface
OgImageSatoriOptionsSatori renderer options.2 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.8 members
module
typesType definitions for OG image generation.

types 1 symbol

interface
TweetBodyDataRoot or quoted post body. Nested quoted_tweet is stripped during normalize.7 members

types 193 symbols

interface
A11yOptionsPer-control flags for ssg.a11y. Omitted fields keep the defaults when the feature itsel…1 member
interface
AbbreviationsOptionsOptions for opt-in abbreviation and glossary expansion.3 members
interface
AttrsOptionsOptions for markdown-it-attrs style attribute blocks. Attribute blocks let authors atta…1 member
interface
BadgeOptionsOptions for opt-in {badge:variant} inline badges.1 member
interface
BlogAuthorOne person in the blog.authors map.3 members
type
BlogFeedFailurePolicy = "warn" | "error"How a failed external feed source is reported.
interface
BlogFeedSourceOne configured external blog feed.4 members
interface
BlogOptionsOpt-in blog index, authors, tags, reading time, and archive.4 members
interface
BuiltinEmbedOptionsBuilt-in embed configuration.30 members
interface
BuiltinPmOptionsOptions for the package-manager install-tab transform.1 member
interface
CardOptionsOptions for opt-in ::: card / ::: link-card / ::: card-grid blocks.1 member
interface
CascadeOptionsOpt-in _index directory frontmatter cascade. false or omitted stays off. true or {} ena…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
CodeGroupOptionsOptions for opt-in ::: code-group fence groups.1 member
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
ConditionalBlockOptionsOptions for opt-in static conditional blocks.2 members
interface
ContainerOptionsOptions for opt-in ::: type custom containers.2 members
interface
ContainerTypeOptionsPer-type container presentation.2 members
interface
ContributorsOptionsOpt-in git contributor list.2 members
interface
DataTableOptionsOptions for opt-in csv-table / json-table fences.3 members
interface
DefinitionListOptionsOptions for opt-in PHP Markdown Extra / mdBook-style definition lists.1 member
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
DocsNavigationItemNavigation item emitted for generated docs sidebars.3 members
interface
DocsOptionsOptions for source documentation generation. The generator extracts JSDoc/TSDoc comment…34 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…6 members
type
EditThisPageProvider = "github" | "gitlab" | "bitbucket" | "gitea"Forges with a known edit-URL shape. 'gitea' covers Forgejo, which kept the same path.
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
FeedChannelOptionsOne feed's formats, source, output path, and channel metadata.11 members
type
FeedFormat = "rss" | "atom" | "json"Feed file formats written during SSG.
interface
FeedItemAttachmentOne JSON Feed / enclosure attachment accepted by programmatic feeds.5 members
interface
FeedItemAuthorOne feed item author accepted by programmatic feeds.2 members
interface
FeedItemInputOne collection or programmatic item considered for a generated feed.17 members
type
FeedsOptions = FeedChannelOptions | readonly FeedChannelOptions[] | { [name: string]: FeedChannelOptions }Opt-in RSS / Atom / JSON Feed files written during SSG. A single object is one default…
interface
FileTreeIconOptionsReplaceable file-tree icons. Values are trusted site-config SVG markup or CSS class tok…4 members
interface
FileTreeOptionsOptions for opt-in file-tree fences.3 members
interface
GeneratedDocsDataMachine-readable payload emitted alongside generated docs.4 members
interface
GeneratedOpenApiDocsGenerated OpenAPI Markdown pages and sidebar metadata.2 members
interface
HeadingPermalinksOptionsOpt-in visible heading permalinks. Headings already have stable ids. Enabling this appe…1 member
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
IconsOptionsOpt-in self-hosted Iconify CSS for used icons. Off by default. When enabled, the SSG bu…4 members
interface
ImageGalleryOptionsOptions for opt-in static image galleries.4 members
interface
ImageOptionsOptions for opt-in figures, captions, and lazy images.1 member
interface
IncludeOptionsOptions for inlining Markdown files with . Relative paths resolv…1 member
interface
JsonLdOptionsPer-control flags for ssg.jsonLd. Omitted fields keep the defaults when the feature its…4 members
type
JsonLdPageType = "TechArticle" | "BlogPosting" | "WebPage"JSON-LD page node @type. Unknown values fall back to TechArticle.
interface
JsonLdPublisherOptionsOptional JSON-LD publisher. Empty or omitted fields are left out.2 members
type
KatexFontFormats = "woff2" | "all"Which of KaTeX's font formats to emit.
interface
KeyboardKeysOptionsOptions for opt-in {kbd:...} inline keyboard keys.3 members
interface
LocaleConfigLocale configuration. Locales define the routing and display metadata used by the i18n…3 members
interface
MagicLinkAliasOne configured magic-link target.3 members
interface
MagicLinkImageOverrideReplace the image for an exact href or prefix.3 members
interface
MagicLinkOptionsOptions for opt-in {link:...} rich magic links.4 members
interface
MarkdownNodeMarkdown AST node (simplified for TypeScript).4 members
interface
MarkdownSourceOptionsOpt-in Markdown source companions written beside generated HTML.2 members
interface
MarkdownTransformerCustom AST transformer.2 members
type
MathErrorPolicy = "literal" | "error" | "render"What to do with a $…$ run KaTeX cannot parse.
interface
MathOptionsOptions for opt-in $…$ / $$…$$ math. Delimiter parsing lives in the native transform. T…3 members
interface
MdxImportOne MDX import statement collected from the AST.2 members
interface
MdxImportSpecifierOne binding created by an MDX import statement.3 members
type
MdxImportSpecifierKind = "default" | "named" | "namespace"How a specifier was imported from an MDX import statement.
interface
NavItemNavigation item for sidebar navigation.3 members
interface
NotByAiOptionsOptions for the opt-in <NotByAI /> authorship badge.3 members
interface
NotFoundOptionsOpt-in custom 404 page written during SSG.2 members
interface
OgImageOptionsOG image generation options. Uses Chromium or Satori rendering with customizable templa…8 members
type
OgImageRenderer = "chromium" | "satori"OG image rendering backend.
interface
OgImageSatoriFontFont file loaded by the Satori renderer.4 members
type
OgImageSatoriFontWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900Font weight values supported by Satori.
interface
OgImageSatoriOptionsSatori renderer options.2 members
interface
OpenApiDocsInputOne local OpenAPI file consumed by generated REST API docs.3 members
interface
OpenApiDocsOptionsObject form for configuring generated OpenAPI docs.3 members
type
OpenApiDocsSource = string | OpenApiDocsInputOpenAPI docs shorthand accepted by docs.openapi.
interface
OxContentOptionsOptions for the core oxContent() Vite plugin. The top-level options describe where cont…76 members
interface
ParamDocParameter documentation.5 members
interface
PartialsOptionsOptions for parameterized Markdown partials with . Bare na…4 members
interface
PermalinksOptionsOpt-in frontmatter permalink / slug routing. false or omitted stays off. true or {} ena…1 member
interface
PublishStateOptionsOpt-in draft / unlisted / scheduled page filtering.3 members
interface
PwaOptionsOpt-in web app manifest and service worker written during SSG. Enabling offline (the de…6 members
type
RedirectProvider = "netlify" | "cloudflare"Host that consumes the generated redirects file. Both values write the same redirects…
interface
RedirectsOptionsOpt-in static redirects, aliases, and path rewrites. A path map such as { "/old-guide":…6 members
type
ResolvedA11y = false | { skipLinkLabel: string }Resolved skip-link / print styles. false means no extra markup or CSS.
interface
ResolvedAbbreviationsOptionsResolved abbreviation / glossary transform options.3 members
interface
ResolvedAttrsOptionsResolved attrs transform options.1 member
interface
ResolvedBadgeOptionsResolved inline-badge transform options.1 member
interface
ResolvedBlogFeedSourceResolved external blog feed source.4 members
interface
ResolvedBlogOptionsResolved blog options.5 members
interface
ResolvedBuiltinEmbedOptionsResolved built-in embed configuration.30 members
interface
ResolvedCardOptionsResolved card transform options.1 member
interface
ResolvedCascadeOptionsResolved cascade options.1 member
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
ResolvedCodeGroupOptionsResolved code-group transform options.1 member
interface
ResolvedCodeImportOptionsResolved code-import transform options.2 members
interface
ResolvedCollectionOptionsResolved collection definition.3 members
interface
ResolvedCollectionsOptionsResolved collection options.2 members
interface
ResolvedConditionalBlockOptionsResolved conditional-block transform options.2 members
interface
ResolvedContainerOptionsResolved custom-container transform options.2 members
type
ResolvedContributors = false | { ignore: string[]; avatars: boolean }Resolved git contributor list. false means the feature is off.
interface
ResolvedDataTableOptionsResolved data-table transform options.3 members
interface
ResolvedDefinitionListOptionsResolved definition-list transform options.1 member
interface
ResolvedDocsEntryPointResolved public API entry point.2 members
interface
ResolvedDocsOptionsResolved docs options with all defaults applied.34 members
interface
ResolvedDocsTestOptionsResolved docs-as-tests extraction options.3 members
interface
ResolvedEditThisPageOptionsResolved edit-link transform options.7 members
interface
ResolvedEmojiShortcodeOptionsResolved emoji-shortcode transform options.2 members
interface
ResolvedFeedChannelOne resolved feed channel.12 members
interface
ResolvedFeedsOptions extends ResolvedFeedChannelResolved feed options. Legacy true / single-object configs keep one channel on the top-…2 members
interface
ResolvedFileTreeOptionsResolved file-tree transform options.7 members
interface
ResolvedHeadingPermalinksOptionsResolved heading permalink options.1 member
interface
ResolvedI18nOptionsResolved i18n options with all defaults applied.7 members
interface
ResolvedIconsOptionsResolved icon asset options.5 members
interface
ResolvedImageGalleryOptionsResolved image gallery transform options.4 members
interface
ResolvedImageOptionsResolved image transform options.2 members
interface
ResolvedIncludeOptionsResolved Markdown-include transform options.2 members
type
ResolvedJsonLd = false | { breadcrumbs: boolean; publisher?: { name?: string; url?: string }; type?: JsonLdPageType; graph?: Record<string, unknown>[] }Resolved JSON-LD options. false means no <script type="application/ld+json">.
interface
ResolvedKeyboardKeysOptionsResolved inline keyboard-key transform options.3 members
interface
ResolvedMagicLinkOptionsResolved magic-link transform options.5 members
interface
ResolvedMarkdownSourceOptionsResolved Markdown source-companion options.3 members
interface
ResolvedMathOptionsResolved math transform options.3 members
interface
ResolvedNotByAiOptionsResolved NotByAI authorship-badge options.3 members
interface
ResolvedNotFoundOptionsResolved custom 404 options.3 members
interface
ResolvedOgImageOptionsResolved OG image options with all defaults applied.8 members
interface
ResolvedOpenApiDocsInputResolved local OpenAPI file input.3 members
interface
ResolvedOpenApiDocsOptionsResolved generated OpenAPI docs options.2 members
interface
ResolvedOptionsResolved options with all defaults applied.75 members
interface
ResolvedPartialsOptionsResolved parameterized-partial transform options.4 members
interface
ResolvedPermalinksOptionsResolved permalink options.1 member
interface
ResolvedPublishStateOptionsResolved publish-state options.3 members
interface
ResolvedPwaOptionsResolved PWA options.7 members
interface
ResolvedRedirectsOptionsResolved redirect options.7 members
interface
ResolvedResourcesOptionsResolved page-resource options.5 members
interface
ResolvedSanitizeOptionsResolved sanitize transform options.4 members
interface
ResolvedSearchOptionsResolved search options.12 members
interface
ResolvedSectionIndexOptionsResolved generated section index options.2 members
interface
ResolvedSiteMapsOptionsResolved crawl-manifest options.3 members
interface
ResolvedSsgOptionsResolved SSG options.32 members
interface
ResolvedStepsOptionsResolved step-list transform options.1 member
interface
ResolvedTaxonomiesOptionsResolved taxonomy options.3 members
interface
ResolvedTeamOptionsResolved team page options.2 members
interface
ResolvedTimelineOptionsResolved timeline transform options.5 members
interface
ResolvedTypedHoverOptionsResolved typed-hover options.3 members
interface
ResolvedVersionEntryOne resolved version after prefix and banner sanitization.5 members
interface
ResolvedVersionsOptionsResolved documentation versioning.5 members
interface
ResolvedWikiLinkOptionsResolved wiki-link transform options.2 members
interface
ResourcesOptionsOptions for opt-in page-bundle resources and image processing.4 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…12 members
interface
SearchResultSearch result structure.7 members
interface
SectionIndexOptionsOpt-in generated section index pages.1 member
type
SectionIndexStyle = "list" | "cards"Listing style for a generated section index.
interface
SiteMapsOptionsOpt-in crawl manifests written during SSG.2 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…32 members
interface
SsgOutputPageInputOne host-owned page for composable SSG outputs (ssg: false). The host renders HTML. Ox…12 members
interface
StepsOptionsOptions for opt-in ::: steps ordered lists.1 member
interface
TaxonomiesOptionsOpt-in term list pages, per-term pages, and related-page lists.2 members
interface
TeamLinkOne link on a team member card.2 members
interface
TeamMemberOne person on the team page.4 members
interface
ThrowsDocException/error documentation.2 members
interface
TimelineOptionsOptions for opt-in static timelines.5 members
interface
TocEntryTable of contents entry.4 members
interface
TransformContextTransform context passed to transformers.3 members
interface
TransformResultTransform result.11 members
interface
TypedHoverOptionsOptions for opt-in typed hover overlays on TypeScript fences. Hover strings are compute…3 members
module
typesType definitions for @ox-content/vite-plugin
type
VersionBannerKind = "unreleased" | "unmaintained"Banner shown on pages that belong to one documented version.
interface
VersionEntryOne published or snapshot version of a docs tree.5 members
interface
VersionsOptionsOpt-in documentation versioning. Off by default. true enables a single current entry. A…4 members
interface
WikiLinkOptionsOptions for expanding Obsidian-style wiki links. The transform accepts [target] and [ta…1 member

url 1 symbol

fn
normalizeOgpUrl(url: string): stringNormalize a URL for cache keys: lowercase host, drop default ports and fragments, and s…1 paramreturns string

version-navigation 1 symbol

module
version-navigationKeeps navigation inside a frozen documentation-version tree. Locale resolution runs bef…

versions-html 1 symbol

module
versions-htmlEscaped version switcher, banner, and badge markup.

versions 6 symbols

fn
currentVersionPrefix(options?: ResolvedVersionsOptions): stringPrefix used for the active version (empty string = site root).1 paramreturns string
fn
decorateVersionedPages(pages: Array<{ outputPath: string; html: string }>, options: ResolvedVersionsOptions, outDir: string, base: string): voidApplies switcher / banner / search rewrite after every version tree is generated.4 paramsreturns void
fn
resolveSnapshotDir(root: string, dir: string): string | undefinedConfines a snapshot dir to root.2 paramsreturns string | undefined
fn
resolveVersionsOptions(value: boolean | VersionsOptions | undefined): ResolvedVersionsOptionsResolves versions. Omitted / false stay off. true enables a single current entry. An ob…1 paramreturns ResolvedVersionsOptions
fn
versionLocation(outputPath: string, outDir: string, options: ResolvedVersionsOptions): { id: string; sibling: string }Version id and same-path remainder for a generated HTML file.3 paramsreturns object
module
versionsOpt-in documentation versioning: prefixes, snapshots, and header chrome. Historical sna…

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 a YouTube video ID from a bare ID or a watch / share / embed / shorts URL. The…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…