# markdown-it-sub

> tag for markdown-it markdown parser.

Latest version **2.0.0** (published 2023-12-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install markdown-it-sub
pnpm add markdown-it-sub
yarn add markdown-it-sub
bun add markdown-it-sub
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-12-05 |
| First published | 2015-01-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 9.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 30 |
| Maintainers | vitaly |
| Keywords | markdown-it-plugin, markdown-it, markdown, subscript, sub |

## Links

- npm: https://www.npmjs.com/package/markdown-it-sub
- Repository: https://github.com/markdown-it/markdown-it-sub
- Homepage: https://github.com/markdown-it/markdown-it-sub#readme
- Issues: https://github.com/markdown-it/markdown-it-sub/issues
- npm.io page: https://npm.io/package/markdown-it-sub

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2023-12-05
- 1.0.0 — 2015-03-12
- 0.1.0 — 2015-01-04

## README

# markdown-it-sub

[![Build Status](https://img.shields.io/travis/markdown-it/markdown-it-sub/master.svg?style=flat)](https://travis-ci.org/markdown-it/markdown-it-sub)
[![NPM version](https://img.shields.io/npm/v/markdown-it-sub.svg?style=flat)](https://www.npmjs.org/package/markdown-it-sub)
[![Coverage Status](https://img.shields.io/coveralls/markdown-it/markdown-it-sub/master.svg?style=flat)](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)

---
_Source: https://npm.io/package/markdown-it-sub · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._