transform.ts

Source

NapiBindings

interface

NAPI bindings for Rust-based Markdown processing. Provides access to compiled Rust functions for high-performance Markdown parsing and rendering operations.

Source

OgImageData

interface

OG image data for generating social media preview images.

Source

OgImageConfig

interface

OG image configuration.

Source

JsTransformOptions

interface

Options for Rust-based Markdown transformation. Controls which Markdown extensions and features are enabled during parsing and rendering.

Source

loadNapiBindings

function

Lazily loads and caches NAPI bindings. This function uses lazy loading to defer the import of NAPI bindings until they're actually needed. The bindings are loaded only once and cached for subsequent uses. If loading fails (e.g., bindings not built), the failure is cached to avoid repeated load attempts.

Performance Considerations

The first call to this function may have a slight performance penalty due to module loading. Subsequent calls use the cached result and are essentially zero-cost.

Error Handling

If NAPI bindings are not available (not built, wrong architecture, etc.), this function returns null. The caller should handle this gracefully or provide fallback behavior.

Source

async function loadNapiBindings(): Promise<NapiBindings | null>

Returns

Promise<NapiBindings | null> - Promise resolving to NAPI bindings or null if unavailable

Examples

// Simple check with fallback
const napi = await loadNapiBindings();
if (!napi) {
  console.warn('NAPI bindings not available, using fallback');
  return fallbackRender(content);
}
// Use Rust implementation
const result = napi.transform(content, { gfm: true });

SsgTransformOptions

interface

SSG-specific transform options.

Source

buildTocTree

function

Builds nested TOC tree from flat list.

Source

function buildTocTree(entries: TocEntry[]): TocEntry[]

Returns

TocEntry[] -

generateModuleCode

function

Generates the JavaScript module code.

Source

extractImports

function

Extracts imports from Markdown content. Supports importing components for interactive islands.

Source

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

Returns

string[] -

generateOgImageSvg

function

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.

Source

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

Parameters

Returns

Promise<string | null> - SVG string or null if NAPI bindings are unavailable