https://github.com/markdown-it/markdown-it-abbr

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

Last synced: 2 days ago
JSON representation

Abbreviation (<abbr>) tag plugin for markdown-it markdown parser

• Host: GitHub
• URL: https://github.com/markdown-it/markdown-it-abbr
• Owner: markdown-it
• License: mit
• Created: 2015-01-04T00:29:49.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-12-06T05:21:31.000Z (over 1 year ago)
• Last Synced: 2025-06-11T03:37:27.717Z (13 days ago)
• Language: JavaScript
• Homepage: https://markdown-it.github.io/
• Size: 29.3 KB
• Stars: 48
• Watchers: 6
• Forks: 13
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

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 (``) 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

The HTML specification

is maintained by the W3C.

```


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