ParseOptions

Example: Usage

import type { ParseOptions } from "@ende/markdown/types";
import { assertEquals } from "@ende/assert";

const options: ParseOptions = { gfm: true };
assertEquals(options.gfm, true);

gfm

gfm?: boolean

Enable the GitHub Flavored Markdown extensions: tables, task list items, strikethrough, extended autolinks (www., http://, https://, ftp:// and email addresses), and footnotes, plus GitHub's alerts (> [!NOTE]), which become Admonition nodes. The Disallowed Raw HTML (tagfilter) extension isn't included. Without it, parsing follows CommonMark exactly.

Default: false

slugger

slugger?: (text: string) => string

Makes a heading id from the heading's plain text: its text and code, and the alt text of its images, without footnote references or raw HTML tags. Ids are made unique afterwards, whatever the slugger returns: a repeated id gets -1, -2 and so on, as Heading.id describes.

Default: slug