micromark-extension-definition-list

micromark extension to support definition lists.

Feature

fully support Definitio Lists Syntax of php-markdown
can be integrated with remark / rehype / unified using mdast-util-definition-list
shipped with types

Install

Install from npm.

$ npm install micromark-extension-definition-list

Use

import { micromark } from 'micromark';
import { defList, defListHtml } from 'micromark-extension-definition-list';

const markdown = `
Apple
:   Pomaceous fruit of plants of the genus Malus in 
    the family Rosaceae.

Orange
:   The fruit of an evergreen tree of the genus Citrus.
`;
const output = micromark(markdown, {
  extensions: [defList],
  htmlExtensions: [defListHtml]
});

Test in develepment

For development purpose, you can run tests with debug messages.

$ DEBUG="micromark-extension-definition-list:syntax" npm run test-dev