Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

markdown-it-sub

markdown-it721.5kMIT2.0.0

tag for markdown-it markdown parser.

markdown-it-plugin, markdown-it, markdown, subscript, sub

readme

markdown-it-sub

Build Status NPM version Coverage Status

Subscript (<sub>) tag plugin for markdown-it markdown parser.

v1.+ requires markdown-it v4.+, see changelog.

H~2~0 => H<sub>2</sub>O

Markup is based on pandoc definition. But nested markup is currently not supported.

Install

node.js, browser:

npm install markdown-it-sub --save
bower install markdown-it-sub --save

Use

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

changelog

2.0.0 / 2023-12-03

  • Rewrite to ESM.
  • Remove dist/ from repo (build on package publish).

1.0.0 / 2015-03-12

  • Markdown-it 4.0.0 support. Use previous version for 2.x-3.x.

0.1.0 / 2015-01-04

  • First release.