# markdown-it-abbr

> tag for markdown-it markdown parser.

Latest version **2.0.0** (published 2023-12-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install markdown-it-abbr
pnpm add markdown-it-abbr
yarn add markdown-it-abbr
bun add markdown-it-abbr
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-12-06 |
| First published | 2015-01-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 20.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 52 |
| Maintainers | vitaly |
| Keywords | markdown-it-plugin, markdown-it, markdown, abbreviation, abbr |

## Links

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

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

- 2.0.0 (latest) — 2023-12-06
- 1.0.4 — 2016-08-31
- 1.0.3 — 2016-01-05
- 1.0.2 — 2015-12-31
- 1.0.1 — 2015-12-31
- 1.0.0 — 2015-03-12
- 0.1.0 — 2015-01-04

## README

# markdown-it-abbr

[![CI](https://github.com/markdown-it/markdown-it-abbr/actions/workflows/ci.yml/badge.svg)](https://github.com/markdown-it/markdown-it-abbr/actions/workflows/ci.yml)
[![NPM version](https://img.shields.io/npm/v/markdown-it-abbr.svg?style=flat)](https://www.npmjs.org/package/markdown-it-abbr)
[![Coverage Status](https://img.shields.io/coveralls/markdown-it/markdown-it-abbr/master.svg?style=flat)](https://coveralls.io/r/markdown-it/markdown-it-abbr?branch=master)

> Abbreviation (`<abbr>`) tag plugin for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser.

__v1.+ requires `markdown-it` v4.+, see changelog.__

Markup is based on [php markdown extra](https://michelf.ca/projects/php-markdown/extra/#abbr) definition, but without multiline support.

Markdown:

```
*[HTML]: Hyper Text Markup Language
*[W3C]:  World Wide Web Consortium
The HTML specification
is maintained by the W3C.
```

HTML:

```html
<p>The <abbr title="Hyper Text Markup Language">HTML</abbr> specification
is maintained by the <abbr title="World Wide Web Consortium">W3C</abbr>.</p>
```

## Install

node.js, browser:

```bash
npm install markdown-it-abbr --save
bower install markdown-it-abbr --save
```

## Use

```js
var md = require('markdown-it')()
            .use(require('markdown-it-abbr'));

md.render(/*...*/) // see example above
```

_Differences in browser._ If you load script directly into the page, without
package system, module will add itself globally as `window.markdownitAbbr`.


## License

[MIT](https://github.com/markdown-it/markdown-it-abbr/blob/master/LICENSE)

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