{"library":"markdown-it-deflist","title":"Markdown-it Definition List Plugin","description":"markdown-it-deflist is a plugin for the popular markdown-it markdown parser, enabling support for definition lists (`<dl>` HTML tags) based on the Pandoc definition list syntax. The current stable version is 3.0.0, released approximately two years ago. While `markdown-it` itself has a more frequent release cadence to address CommonMark specification updates and security fixes, its plugins like `markdown-it-deflist` typically update less often, primarily for compatibility with new `markdown-it` major versions or to introduce new features. As the official definition list plugin, its key differentiator is its seamless integration into the `markdown-it` ecosystem, providing a standardized way to render definition lists where this functionality is not included in the core parser.","language":"javascript","status":"active","last_verified":"Sun Apr 19","install":{"commands":["npm install markdown-it-deflist"],"cli":null},"imports":["import markdownitDeflist from 'markdown-it-deflist';","import markdownit from 'markdown-it';\nimport markdownitDeflist from 'markdown-it-deflist';\n\nconst md = markdownit().use(markdownitDeflist);","const markdownit = require('markdown-it');\nconst markdownitDeflist = require('markdown-it-deflist');\n\nconst md = markdownit().use(markdownitDeflist);"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import markdownit from 'markdown-it';\nimport markdownitDeflist from 'markdown-it-deflist';\n\nconst md = markdownit();\nmd.use(markdownitDeflist);\n\nconst markdownInput = `\nTerm 1\n  : Definition 1\n\nTerm 2\n  : Definition 2a\n  : Definition 2b\n\nCompact Term\n~ Compact Definition\n~ Another Compact Definition\n`;\n\nconst htmlOutput = md.render(markdownInput);\nconsole.log(htmlOutput);\n/* Expected output:\n<dl>\n<dt>Term 1</dt>\n<dd>Definition 1</dd>\n<dt>Term 2</dt>\n<dd>Definition 2a</dd>\n<dd>Definition 2b</dd>\n</dl>\n<dl>\n<dt>Compact Term</dt>\n<dd>Compact Definition</dd>\n<dd>Another Compact Definition</dd>\n</dl>\n*/","lang":"typescript","description":"Demonstrates how to import and register the markdown-it-deflist plugin with markdown-it, then render a sample markdown string containing definition lists to HTML.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}