@mirrordown/remd-sub

Part of Mirrordown — a suite of markdown syntax extensions for the unified and markdown-it ecosystems.

A remark/rehype (unified) plugin for the sub syntax extension.

Overview

The sub plugin renders ~text~ as an HTML <sub> element, representing subscript text.

<sub>text</sub>

Syntax

Wrap text in single tildes to render it as subscript:

The chemical formula for water is H~2~O.

Carbon dioxide is CO~2~.

Install

npm install @mirrordown/remd-sub

Unified

import { unified } from "unified";
import remarkParse from "remark-parse";
import remarkRehype from "remark-rehype";
import rehypeStringify from "rehype-stringify";
import { remarkSub } from "@mirrordown/remd-sub";

const processor = unified()
  .use(remarkParse)
  .use(remarkSub)
  .use(remarkRehype)
  .use(rehypeStringify);

Astro

// astro.config.ts
import { defineConfig } from "astro/config";
import { remarkSub } from "@mirrordown/remd-sub";

export default defineConfig({
  markdown: {
    remarkPlugins: [remarkSub]
  }
});

VitePress

// .vitepress/config.ts
import { defineConfig } from "vitepress";
import { remarkSub } from "@mirrordown/remd-sub";

export default defineConfig({
  markdown: {
    remarkPlugins: [remarkSub]
  }
});

Documentation

Full documentation, more examples, and configuration options: github.com/mirrordown/mirrordown (dedicated docs site coming soon).

License

MIT © Drake Costa