@mirrordown/mdit-del

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

A markdown-it plugin for the del syntax extension.

Overview

The del plugin renders --text-- as an HTML <del> element, representing deleted or struck-through text.

<del>text</del>

Syntax

Wrap text in double dashes to mark it as deleted:

--This text has been deleted.--

You can use it inline: the price was --$50-- $35.

Install

npm install @mirrordown/mdit-del

Standalone

import MarkdownIt from "markdown-it";
import { del } from "@mirrordown/mdit-del";

const md = new MarkdownIt().use(del);

VitePress

// .vitepress/config.ts
import { defineConfig } from "vitepress";
import { del } from "@mirrordown/mdit-del";

export default defineConfig({
  markdown: {
    config: (md) => md.use(del)
  }
});

Documentation

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

License

MIT © Drake Costa