Type Alias: Format

Format = "text" | "html" | "markdown" | { format: "markdown"; gfm?: boolean; }

Input / output format for Gukhanmun.convert and Gukhanmun.stream.

  • "text" — Plain text (default). No markup interpretation; ruby rendering falls back to parentheses.
  • "html" — HTML fragment. The scanner is fragment-oriented and recovers from minor malformations.
  • "markdown" — CommonMark Markdown (GFM disabled by default).
  • { format: "markdown"; gfm?: boolean } — Markdown with optional GFM extensions. Set gfm: true to enable GitHub Flavored Markdown tables, strikethrough, and task lists.

The object form { format: "markdown" } is equivalent to the string "markdown".