comark-deflist

Definition lists in Comark: a term, then : definition lines, rendered as native <dl>, <dt>, and <dd>. A parse plugin with no components and no styles, so it works in any renderer.

pnpm add comark comark-deflist

import { parseMarkdown } from "comark";
import deflist from "comark-deflist";

const document = await parseMarkdown(markdown, {
  plugins: [deflist()],
});

Flaky test
: A test that passes and fails on the same code.

Rubber duck
: A listener who doesn't need to understand the bug.
~ A bath toy.

Pigeon count
:   The number of pigeons on the office roof at 9:00.

    Above 12, the deploy waits.

A term is one line, and each definition starts with : or ~ and a space. Lines indented past the marker continue the definition, so it can hold paragraphs, lists, and code.

Credits

Ported from markdown-it-deflist by Vitaly Puzrin and Alex Kocharin, MIT.