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.
29 lines
1.0 KiB
29 lines
1.0 KiB
2 years ago
|
# markdown-it-deflist
|
||
|
|
|
||
|
|
[](https://travis-ci.org/markdown-it/markdown-it-deflist)
|
||
|
|
[](https://www.npmjs.org/package/markdown-it-deflist)
|
||
|
|
[](https://coveralls.io/r/markdown-it/markdown-it-deflist?branch=master)
|
||
|
|
|
||
|
|
> Definition list (`<dl>`) tag plugin for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser.
|
||
|
|
|
||
|
|
Syntax is based on [pandoc definition lists](http://johnmacfarlane.net/pandoc/README.html#definition-lists).
|
||
|
|
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install markdown-it-deflist --save
|
||
|
|
```
|
||
|
|
|
||
|
|
## Use
|
||
|
|
|
||
|
|
```js
|
||
|
|
var md = require('markdown-it')()
|
||
|
|
.use(require('markdown-it-deflist'));
|
||
|
|
|
||
|
|
md.render(/*...*/);
|
||
|
|
```
|
||
|
|
|
||
|
|
_Differences in browser._ If you load script directly into the page, without
|
||
|
|
package system, module will add itself globally as `window.markdownitDeflist`.
|