# mini-markdown-it-plugins

> A set of useful plugins for markdown-it, including emoji, container, and footnote extensions.

Latest version **3.0.3** (published 2024-03-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install mini-markdown-it-plugins
pnpm add mini-markdown-it-plugins
yarn add mini-markdown-it-plugins
bun add mini-markdown-it-plugins
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.3 |
| Published | 2024-03-11 |
| First published | 2024-03-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Artem Olegovich |
| Maintainers | kulaginoleksii |
| Keywords | markdown-it, plugin, markdown, emoji, container, footnote, abbreviation, subscript |

## Links

- npm: https://www.npmjs.com/package/mini-markdown-it-plugins
- Repository: https://github.com/kulaginoleksii/markdown-it-plugins
- Homepage: https://github.com/kulaginoleksii/markdown-it-plugins#readme
- Issues: https://github.com/kulaginoleksii/markdown-it-plugins/issues
- npm.io page: https://npm.io/package/mini-markdown-it-plugins

## Dependencies (7)

- [markdown-it](https://npm.io/package/markdown-it.md) ^12.0.4
- [markdown-it-sub](https://npm.io/package/markdown-it-sub.md) ^1.0.0
- [markdown-it-sup](https://npm.io/package/markdown-it-sup.md) ^1.0.0
- [markdown-it-abbr](https://npm.io/package/markdown-it-abbr.md) ^1.0.4
- [markdown-it-emoji](https://npm.io/package/markdown-it-emoji.md) ^2.0.0
- [markdown-it-footnote](https://npm.io/package/markdown-it-footnote.md) ^3.0.2
- [markdown-it-container](https://npm.io/package/markdown-it-container.md) ^3.0.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 3.0.3 (latest) — 2024-03-11
- 3.0.2 — 2024-03-11

## README

# 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:

```bash
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:

```javascript
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.

---
_Source: https://npm.io/package/mini-markdown-it-plugins · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._