@mirrordown/mdit-mark

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

A markdown-it plugin for the mark syntax extension.

Overview

The mark plugin renders ==text== as an HTML <mark> element, representing highlighted or marked text.

<mark>text</mark>

Syntax

Wrap text in double equals signs to highlight it:

==This text is highlighted.==

You can use it inline: remember to ==save your work== before closing.

Install

npm install @mirrordown/mdit-mark

Standalone

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

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

VitePress

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

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

Documentation

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

License

MIT © Drake Costa