Skip to content
ironmark

Presets

Named presets set several options at once. Explicit options always override the preset.

PresetDescription
"default"All extensions enabled. The default behaviour.
"safe"Disables raw HTML and enables the GFM tag filter. Use it for untrusted input.
"strict"CommonMark only: disables extensions and permissive behaviour.
"llm"Deterministic, stable output for AI pipelines. Disables ambiguous extensions, enables heading ids.
import { markdownToHtml } from "ironmark";
 
// Use a preset
const html = markdownToHtml(content, { preset: "safe" });
 
// Presets compose with explicit options (explicit wins)
const html2 = markdownToHtml(content, { preset: "llm", enableTables: false });

PRESETS lists the exact options each preset applies:

import { PRESETS } from "ironmark";
 
PRESETS.llm; // { enableAutolink: false, enableHeadingIds: true, … }

Presets and with()

On documents and instances, a with() layer that sets preset starts again from that preset and drops earlier options. A layer without preset overrides only its own keys.

import ironmark from "ironmark";
 
const md = ironmark.with({ preset: "safe", enableHeadingIds: true });
md.with({ enableTables: false }); // still safe, still heading ids
md.with({ preset: "strict" }); // strict only: earlier options are dropped

Presets are JavaScript only. In Rust, build a ParseOptions with the fields you need. On the CLI, use --preset <name> or --safe.

Edit this page on GitHub