API Reference

convert()

Synchronous HTML to Markdown conversion.

function convert(html: string, options?: ConvertOptions): string

Parameters:

Returns: string - The converted Markdown

Example:

import { convert } from '@vakra-dev/supermarkdown';

const markdown = convert('<h1>Hello</h1><p>World</p>');
// => "# Hello\n\nWorld"

convertAsync()

Asynchronous conversion for large documents. Useful when you don't want to block the main thread.

function convertAsync(html: string, options?: ConvertOptions): Promise<string>

Parameters:

Returns: Promise<string> - The converted Markdown

Example:

import { convertAsync } from '@vakra-dev/supermarkdown';

const markdown = await convertAsync(largeHtmlDocument, {
  excludeSelectors: ['script', 'style', 'nav'],
});

ConvertOptions

Configuration options for conversion.

interface ConvertOptions {
  headingStyle?: 'atx' | 'setext';
  linkStyle?: 'inline' | 'referenced';
  codeFence?: '`' | '~';
  bulletMarker?: '-' | '*' | '+';
  baseUrl?: string;
  excludeSelectors?: string[];
  includeSelectors?: string[];
}

See Options for detailed documentation of each option.