mini-markdown-it-plugins

markdown-it-plugins

This library enhances the markdown-it parser with a set of useful plugins, including support for emojis, custom containers, footnotes, abbreviations, subscript, and superscript text.

Installation

To install markdown-it-plugins, run the following command in your terminal:

npm install markdown-it-plugins

Usage

After installation, you can use markdown-it-plugins in your project to extend markdown-it with the included plugins. Here's a basic example:

const markdownItPlugins = require('markdown-it-plugins');

// Initialize with options (optional)
const md = markdownItPlugins({
md: { linkify: true, typographer: true }
});

// Render some markdown
const result = md.render('# Your markdown here\n\nWith some :emoji: and ^superscript^ text.');
console.log(result);

Options

You can pass options to markdown-it when initializing markdown-it-plugins to customize the behavior of the markdown parser and the plugins. Refer to the markdown-it documentation for a full list of available options.

Plugins Included

This library bundles the following plugins for markdown-it:

• markdown-it-emoji: Adds emoji support using shortcuts (e.g., :smile:).
• markdown-it-container: Enables custom containers for block quotes, spoilers, etc.
• markdown-it-footnote: Adds footnote functionality.
• markdown-it-abbr: Supports abbreviations via a simple syntax.
• markdown-it-sub: Allows for subscript text.
• markdown-it-sup: Allows for superscript text.

Each plugin can be individually configured if needed. Consult the respective plugin's documentation for configuration options.

Customizing and Extending

markdown-it-plugins is designed to be flexible. You can add or remove plugins by modifying the src/index.js file. This allows for a tailored markdown parsing experience suited to your project's needs.

License

This project is licensed under the ISC License. See the LICENSE file for details.

Contributing

Contributions to markdown-it-plugins are welcome! Please submit a pull request or open an issue for any bugs, feature requests, or improvements.