Markdown Definition List <dl>

Adds HTML Definition List <dl> support to VSCode's markdown preview.

Overview

The definition-list plugin renders Pandoc-style definition lists as HTML <dl>, <dt>, and <dd> elements.

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

Syntax

Write a term on one line, then follow it with one or more definitions prefixed by : or ~ :

Apple
: A round fruit with red or green skin.
: Also a technology company.

Orange
: A citrus fruit with orange skin.

Multiple terms can share definitions:

HTTP
HTTPS
: Protocols for transferring data on the web.

Each definition is tight or loose on its own. A definition is loose, and wraps its content in <p>, when a blank line comes directly before its marker or separates blocks inside it. Otherwise its paragraphs render unwrapped. A marker with nothing after it produces an empty <dd>.

About

Part of Markdown Preview Extended Syntax — a pack of Markdown preview syntax extensions you can install all at once.

Powered by @mirrordown/mdit-definition-list · Source on GitHub.