markdown-it-deflist

What is markdown-it-deflist?

The markdown-it-deflist package is a plugin for the markdown-it Markdown parser that adds support for definition lists. Definition lists are a type of list where each term is followed by its definition, which is useful for creating glossaries, dictionaries, or any other content that requires term-definition pairs.

What are markdown-it-deflist's main functionalities?

Basic Definition List

This feature allows you to create a basic definition list. The code sample demonstrates how to use the markdown-it-deflist plugin to parse a simple definition list with two terms and their corresponding definitions.

const md = require('markdown-it')().use(require('markdown-it-deflist'));
const result = md.render('Term 1\n: Definition 1\n\nTerm 2\n: Definition 2');
console.log(result);

Multi-line Definitions

This feature supports multi-line definitions, allowing definitions to span multiple lines. The code sample shows how to create a definition list where the definition of 'Term 1' continues on the next line.

const md = require('markdown-it')().use(require('markdown-it-deflist'));
const result = md.render('Term 1\n: Definition 1\n  continues on the next line\n\nTerm 2\n: Definition 2');
console.log(result);

Nested Definition Lists

This feature allows for nested definition lists, where a definition can contain another term-definition pair. The code sample demonstrates how to create a nested definition list.

const md = require('markdown-it')().use(require('markdown-it-deflist'));
const result = md.render('Term 1\n: Definition 1\n  : Sub-definition 1\n\nTerm 2\n: Definition 2');
console.log(result);

Other packages similar to markdown-it-deflist

markdown-it

markdown-it is a Markdown parser that is highly extensible and pluggable. While it does not natively support definition lists, it can be extended with plugins like markdown-it-deflist to add this functionality. It is known for its speed and flexibility.

remark

remark is a Markdown processor powered by plugins. It can be extended to support definition lists through plugins like remark-deflist. It offers a different ecosystem and set of plugins compared to markdown-it, and is known for its modularity and ease of use.

markdown-it-container

markdown-it-container is a markdown-it plugin that allows you to create custom containers. While it does not specifically support definition lists, it can be used to create custom block-level containers that could mimic definition list behavior with additional styling and scripting.

README

markdown-it-deflist

Definition list (<dl>) tag plugin for markdown-it markdown parser.

v2.+ requires markdown-it v5.+, see changelog.

Syntax is based on pandoc definition lists.

Install

node.js, browser:

npm install markdown-it-deflist --save
bower install markdown-it-deflist --save

Use

var md = require('markdown-it')()
            .use(require('markdown-it-deflist'));

md.render(/*...*/);

Differences in browser. If you load script directly into the page, without package system, module will add itself globally as window.markdownitDeflist.

License

MIT