Name	Last modified	Size	Description
	Parent Directory		-
	dist/	2023-06-19 12:50	-
	index.js	2016-08-31 11:58	4.7K
	package.json	2023-06-19 12:51	1.7K
	README.md	2015-03-12 09:17	1.6K
	LICENSE	2014-12-31 22:37	1.1K
	CHANGELOG.md	2016-08-31 11:58	602
	bower.json	2015-01-04 01:08	533

# markdown-it-abbr

[![Build Status](https://img.shields.io/travis/markdown-it/markdown-it-abbr/master.svg?style=flat)](https://travis-ci.org/markdown-it/markdown-it-abbr)
[![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)