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.
41 lines
1.3 KiB
41 lines
1.3 KiB
4 weeks ago
|
# markdown-it-mark
|
||
|
|
|
||
|
|
[](https://travis-ci.org/markdown-it/markdown-it-mark)
|
||
|
|
[](https://www.npmjs.org/package/markdown-it-mark)
|
||
|
|
[](https://coveralls.io/r/markdown-it/markdown-it-mark?branch=master)
|
||
|
|
|
||
|
|
> `<mark>` tag plugin for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser.
|
||
|
|
|
||
|
|
__v2.+ requires `markdown-it` v5.+, see changelog.__
|
||
|
|
|
||
|
|
`==marked==` => `<mark>inserted</mark>`
|
||
|
|
|
||
|
|
Markup uses the same conditions as CommonMark [emphasis](http://spec.commonmark.org/0.15/#emphasis-and-strong-emphasis).
|
||
|
|
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
node.js, browser:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install markdown-it-mark --save
|
||
|
|
bower install markdown-it-mark --save
|
||
|
|
```
|
||
|
|
|
||
|
|
## Use
|
||
|
|
|
||
|
|
```js
|
||
|
|
var md = require('markdown-it')()
|
||
|
|
.use(require('markdown-it-mark'));
|
||
|
|
|
||
|
|
md.render('==marked==') // => '<p><mark>marked</mark></p>'
|
||
|
|
```
|
||
|
|
|
||
|
|
_Differences in browser._ If you load script directly into the page, without
|
||
|
|
package system, module will add itself globally as `window.markdownitMark`.
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
[MIT](https://github.com/markdown-it/markdown-it-mark/blob/master/LICENSE)
|