transform.ts#

12 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.

12 symbols 5 functions 5 interfaces 1 variables 1 modules 21 parameters 66 members 5 returns 1 examples

Reference#

fnextractImports(content: string): string[]Extracts imports from Markdown content. Supports importing components for inter…1 paramreturns string[]

Extracts imports from Markdown content.

Supports importing components for interactive islands.

Signature

export function extractImports(content: string): string[]

View source

Parameters

content string

Returns

string[]

generateModuleCode(html: string, frontmatter: Record<string, unknown>, toc: TocEntry[], imports: MdxImport[], exports: string[], components: string[], crossReferences: CrossReferenceEntry[], citations: CitationReference[], bibliography: BibliographyEntry[], filePath: string): string

Generates the JavaScript module code. MDX metadata is serialized as JSON. User…10 paramsreturns string

Generates the JavaScript module code.

MDX metadata is serialized as JSON. User import / export source is never emitted as live JavaScript, so transform does not execute module side effects.

Signature

function generateModuleCode(html: string, frontmatter: Record<string, unknown>, toc: TocEntry[], imports: MdxImport[], exports: string[], components: string[], crossReferences: CrossReferenceEntry[], citations: CitationReference[], bibliography: BibliographyEntry[], filePath: string): string

View source

Parameters

html string
frontmatter Record<string, unknown>
toc TocEntry[]
imports MdxImport[]
exports string[]
components string[]
crossReferences CrossReferenceEntry[]
citations CitationReference[]
bibliography BibliographyEntry[]
filePath string

Returns

string

fngenerateOgImageSvg(data: OgImageData, config?: OgImageConfig): Promise<string | null>Generates an OG image SVG using the Rust-based generator. This function uses th…2 paramsreturns Promise<string | null>

Generates an OG image SVG using the Rust-based generator.

This function uses the Rust NAPI bindings to generate SVG-based OG images for social media previews. The SVG can be served directly or converted to PNG/JPEG for broader compatibility.

In the future, custom JS templates can be provided to override the default Rust-based template.

Signature

export async function generateOgImageSvg(data: OgImageData, config?: OgImageConfig): Promise<string | null>

View source

Parameters

data OgImageData

OG image data (title, description, etc.)
config OgImageConfig

Optional OG image configuration — optional

Returns

Promise<string | null>

SVG string or null if NAPI bindings are unavailable

interfaceJsTransformOptionsOptions for Rust-based Markdown transformation. Controls which Markdown extensi…45 members

Options for Rust-based Markdown transformation.

Controls which Markdown extensions and features are enabled during parsing and rendering.

Signature

interface JsTransformOptions

View source

Members

Properties

Name	Type	Description
`abbreviations`optional	`{ enabled?: boolean; terms?: Record<string, string>; firstUseOnly?: boolean }`
`attributes`optional	`{ enabled?: boolean }`
`autolinks`optional	`boolean`	Enable automatic link conversion (URLs become clickable). Default `false`
`autolinkUrls`optional	`boolean`	Linkify bare URLs while rendering. Default `true`
`badges`optional	`{ enabled?: boolean }`
`baseUrl`optional	`string`	Base URL for absolute link conversion (e.g., "/" or "/docs/"). Default `"/"`
`cards`optional	`{ enabled?: boolean }`
`cjkEmphasis`optional	`boolean`
`codeAnnotationDefaultLineNumbers`optional	`boolean`	Enable line numbers for all code blocks by default. Default `false`
`codeAnnotationMetaKey`optional	`string`	Fence meta key used to read code annotations. Default `"annotate"`
`codeAnnotations`optional	`boolean`	Enable line annotations for code blocks using fence meta. Default `false`
`codeAnnotationSyntax`optional	`"attribute" \| "vitepress" \| "both"`	Code annotation syntax mode. Default `"attribute"`
`codeGroups`optional	`{ enabled?: boolean }`
`codeImports`optional	`{ enabled?: boolean; rootDir?: string }`
`conditionalBlocks`optional	`{ enabled?: boolean; values?: Record<string, unknown> }`
`containers`optional	`{ enabled?: boolean; types?: Record<string, { title?: string; tag?: string }> }`
`convertMdLinks`optional	`boolean`	Convert `.md` links to `.html` links for SSG output. Default `false`
`dataTables`optional	`{ enabled?: boolean; rootDir?: string; missing?: "error" \| "warn" }`
`definitionLists`optional	`{ enabled?: boolean }`
`editThisPage`optional	`{ enabled?: boolean; repoUrl?: string; branch?: string; rootDir?: string; srcDir?: string; provider?: string; urlPattern?: string; label?: string }`
`emojiShortcodes`optional	`{ enabled?: boolean; custom?: Record<string, string> }`
`fileTree`optional	`{ enabled?: boolean; defaultOpen?: boolean; icons?: boolean; iconFolder?: string; iconFolderOpen?: string; iconFile?: string; iconFiles?: Record<string, string> }`
`footnotes`optional	`boolean`	Enable footnotes syntax ([^1]: definition). Default `false`
`frontmatter`optional	`boolean`	Parse YAML frontmatter before transforming. Default `true`
`gfm`optional	`boolean`	Enable GitHub Flavored Markdown extensions. Includes tables, task lists, strikethrough, and autolinks. Default `false`
`headingPermalinks`optional	`boolean`	Append visible heading permalinks. Default `false`
`imageGalleries`optional	`{ enabled?: boolean; lazy?: boolean; missingAlt?: "error" \| "warn" \| "ignore"; empty?: "error" \| "warn" \| "ignore" }`
`images`optional	`{ enabled?: boolean; lazy?: boolean }`
`includes`optional	`{ enabled?: boolean; rootDir?: string }`
`keyboardKeys`optional	`{ enabled?: boolean; aliases?: Record<string, string>; style?: string }`
`magicLinks`optional	`{ enabled?: boolean; aliases?: Record<string, { href: string; label?: string; image?: string }>; favicon?: boolean; faviconTemplate?: string; imageOverrides?: Array<{ href?: string; prefix?: string; image: string }> }`
`math`optional	`boolean \| { enabled?: boolean }`	Opt-in $…$ inline and $…$ block math. Omitted or `false` leaves `$` literal. `true` or `{}` enables defaults; `{ enabled: false }` disables math. Default `false`
`mdx`optional	`boolean`	Enable MDX JSX, ESM, and expression nodes. Default `false`
`notByAi`optional	`{ enabled?: boolean; label?: string; href?: string }`
`partials`optional	`{ enabled?: boolean; rootDir?: string; root?: string; missing?: string }`
`sanitize`optional	`JsSanitizeOptions`
`semanticFootnotes`optional	`boolean`	Render footnotes as a semantic ordered section with numeric markers. Default `false`
`sourcePath`optional	`string`	Source file path for relative link resolution. Used to determine if the current file is an index file.
`steps`optional	`{ enabled?: boolean }`
`strikethrough`optional	`boolean`	Enable strikethrough syntax (~~text~~). Requires GFM to be enabled. Default `false`
`tables`optional	`boolean`	Enable table rendering (GFM extension). Requires GFM to be enabled for full functionality. Default `false`
`taskLists`optional	`boolean`	Enable task list syntax (- [ ] unchecked, - [x] checked). Default `false`
`timelines`optional	`{ enabled?: boolean; ordered?: boolean; invalidDate?: "error" \| "warn" \| "ignore"; unknownMeta?: "error" \| "warn" \| "ignore"; empty?: "error" \| "warn" \| "ignore" }`
`tocMaxDepth`optional	`number`	Maximum heading depth for table of contents. Headings deeper than this level are excluded from TOC. Default `3`
`wikiLinks`optional	`{ enabled?: boolean; baseUrl?: string }`

interfaceNapiTransformResultWhat the native transform entry points return.7 members

What the native transform entry points return.

Signature

interface NapiTransformResult

View source

Members

Properties

Name	Type	Description
`components`	`string[]`
`errors`	`string[]`
`exports`	`string[]`
`frontmatter`	`string`
`html`	`string`
`imports`	`MdxImport[]`
`toc`	`Array<{ depth: number; text: string; slug: string; children?: TocEntry[] }>`

interfaceOgImageConfigOG image configuration.6 members

OG image configuration.

Signature

export interface OgImageConfig

View source

Members

Properties

Name	Type	Description
`backgroundColor`optional	`string`	Background color (hex)
`descriptionFontSize`optional	`number`	Description font size
`height`optional	`number`	Image height in pixels
`textColor`optional	`string`	Text color (hex)
`titleFontSize`optional	`number`	Title font size
`width`optional	`number`	Image width in pixels

interfaceOgImageDataOG image data for generating social media preview images.4 members

OG image data for generating social media preview images.

Signature

export interface OgImageData

View source

Members

Properties

Name	Type	Description
`author`optional	`string`	Author name
`description`optional	`string`	Page description
`siteName`optional	`string`	Site name
`title`	`string`	Page title

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 th…6 paramsreturns Promise<NapiTransformResult>

Runs the configured transformers over the parsed tree.

Markdown never passes through Vite's transform hook — the native layer reads it directly — so this is the only place user config can reach the AST. The tree is handed over after frontmatter parsing and Markdown feature expansion, and handed back for rendering, HTML postprocessing, and sanitization, so a transformer costs a document nothing else.

A transformer that throws, or returns something that is not a node, is reported and skipped: one bad hook should not take the page down with it.

Signature

async function runTransformers(napi: NapiBindings, markdown: string, napiOptions: JsTransformOptions, filePath: string, options: ResolvedOptions, transformers: readonly MarkdownTransformer[]): Promise<NapiTransformResult>

View source

Parameters

napi NapiBindings
markdown string
napiOptions JsTransformOptions
filePath string
options ResolvedOptions
transformers readonly MarkdownTransformer[]

Returns

Promise<NapiTransformResult>

interfaceSsgTransformOptionsSSG-specific transform options.4 members

SSG-specific transform options.

Signature

export interface SsgTransformOptions

View source

Members

Properties

Name	Type	Description
`baseUrl`optional	`string`	Base URL for absolute link conversion
`convertMdLinks`optional	`boolean`	Convert `.md` links to `.html` links
`sourcePath`optional	`string`	Source file path for relative link resolution
`srcDir`optional	`string`	Absolute source root, used to place pages inside the repository

moduletransformMarkdown Transformation Engine This module handles the complete transformation pipeline for Markdown files, converting…1 example

Markdown Transformation Engine

This module handles the complete transformation pipeline for Markdown files, converting raw Markdown content into JavaScript modules that can be imported by web applications. The transformation process includes:

Parsing: Uses Rust-based parser via NAPI bindings for high performance
Rendering: Converts parsed AST to semantic HTML
Enhancement: Applies syntax highlighting, Mermaid diagram rendering, etc.
Code Generation: Generates JavaScript/TypeScript module code

The generated modules export:

html: Rendered HTML content
frontmatter: Parsed YAML metadata
toc: Hierarchical table of contents
imports: MDX import statements from the AST
exports: MDX export names from the AST
components: Unique JSX component names from the AST
render: Client-side render function for dynamic updates

View source

Examples

Example 1

import { transformMarkdown } from './transform';

const content = await transformMarkdown(
  '# Hello\n\nWorld',
  'path/to/file.md',
  resolvedOptions
);

console.log(content.html); // '<h1>Hello</h1><p>World</p>'
console.log(content.toc);  // [{ depth: 1, text: 'Hello', slug: 'hello', children: [] }]

variableconst UNHIGHLIGHTED_CODE_BLOCK = /<pre(?![^>]*ox-highlight)[^>]*><code class="language-/A <pre> that names a language but has not been highlighted yet.

A <pre> that names a language but has not been highlighted yet.

Signature

const UNHIGHLIGHTED_CODE_BLOCK = /<pre(?![^>]*ox-highlight)[^>]*><code class="language-/

View source

fnwarnMathFailures(failures: MathRenderFailure[], filePath: string): voidReports every

…

run KaTeX refused. Under the default policy the page keeps it…2 paramsreturns void

Reports every $…$ run KaTeX refused.

Under the default policy the page keeps its prose, which is the readable outcome but also a silent one — a genuine mistake in a formula would otherwise leave no trace at all.

Signature

function warnMathFailures(failures: MathRenderFailure[], filePath: string): void

View source

Parameters

failures MathRenderFailure[]
filePath string

Returns

void