micromark-extension-sub-sup

Micromark extension for subscript (_{...}) and superscript (^{...}) syntax.

Install

npm install micromark-extension-sub-sup

Use

import { micromark } from 'micromark'
import { subSup } from 'micromark-extension-sub-sup'

const html = micromark('H_{2}O and x^{2}', {
  extensions: [subSup()]
})

Syntax

H_{2}O              subscript
x^{2}               superscript
_{a{b}c}            nested braces preserved
_{a\}b}             escaped closing brace

Rules

• Starts with _{ or ^{
• Ends with } (with brace balancing)
• Cannot span multiple lines

Escaping

• \} → escaped } (doesn't close)
• \{ → escaped { (doesn't affect brace depth)
• \\ → escaped \

Tokens

This extension creates the following tokens:

• subscript — whole subscript
• subscriptMarker — the _{ and }
• subscriptData — content between markers
• superscript — whole superscript
• superscriptMarker — the ^{ and }
• superscriptData — content between markers

Related

• mdast-util-sub-sup — mdast utilities
• remark-sub-sup — remark plugin

License

MIT