You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
53 lines
1.6 KiB
53 lines
1.6 KiB
# markdown-it-abbr |
|
|
|
[](https://travis-ci.org/markdown-it/markdown-it-abbr) |
|
[](https://www.npmjs.org/package/markdown-it-abbr) |
|
[](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)
|
|
|