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
2 years ago
|
# markdown-it-sub
|
||
|
|
|
||
|
|
[](https://travis-ci.org/markdown-it/markdown-it-sub)
|
||
|
|
[](https://www.npmjs.org/package/markdown-it-sub)
|
||
|
|
[](https://coveralls.io/r/markdown-it/markdown-it-sub?branch=master)
|
||
|
|
|
||
|
|
> Subscript (`<sub>`) tag plugin for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser.
|
||
|
|
|
||
|
|
__v1.+ requires `markdown-it` v4.+, see changelog.__
|
||
|
|
|
||
|
|
`H~2~0` => `H<sub>2</sub>O`
|
||
|
|
|
||
|
|
Markup is based on [pandoc](http://johnmacfarlane.net/pandoc/README.html#superscripts-and-subscripts) definition. But nested markup is currently not supported.
|
||
|
|
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
node.js, browser:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install markdown-it-sub --save
|
||
|
|
bower install markdown-it-sub --save
|
||
|
|
```
|
||
|
|
|
||
|
|
## Use
|
||
|
|
|
||
|
|
```js
|
||
|
|
var md = require('markdown-it')()
|
||
|
|
.use(require('markdown-it-sub'));
|
||
|
|
|
||
|
|
md.render('H~2~0') // => '<p>H<sub>2</sub>O</p>'
|
||
|
|
```
|
||
|
|
|
||
|
|
_Differences in browser._ If you load script directly into the page, without
|
||
|
|
package system, module will add itself globally as `window.markdownitSub`.
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
[MIT](https://github.com/markdown-it/markdown-it-sub/blob/master/LICENSE)
|