Plugins

Definition Lists

nizel-plugin-deflist converts definition-list syntax into <dl>, <dt>, and <dd> output.

Install

npm install nizel-plugin-deflist

Usage

import { useNizel } from 'nizel';
import { deflistPlugin } from 'nizel-plugin-deflist';

const nizel = useNizel({
  plugins: [deflistPlugin()],
});

::deflist
const html = await nizel.html(`Term
: Definition`);
::

Preview

Term

Definition

Other term

First definition

Second definition

Syntax

::deflist
Term
: Definition

Other term
: First definition
: Second definition
::

A definition term is a non-empty line followed by one or more lines that start with : .

Options

Output

<dl>
  <dt>Term</dt>
  <dd>Definition</dd>
</dl>

The plugin transforms matching source groups before parse, then renders the generated internal custom block as escaped HTML.