MDEverywhere

MDEverywhere is an ESM-first Markdown conversion library with a small browser demo. It converts Markdown into platform-friendly text for WhatsApp, Slack, Discord, Telegram, Notion, GitHub, LinkedIn, plain text, and HTML.

Repository Layout

• src/ contains the publishable ESM library
• demo/ contains the static browser demo used for local preview and GitHub Pages
• test/ contains the automated test suite
• Root config files handle linting, tests, packaging, and workflows

Install

pnpm install
pnpm dev

Open http://localhost:8000/demo/.

On GitHub Pages, the demo is served from /demo/.

Package Usage

import { convertMarkdown, convertToSlack } from "@sunanmau5/mdeverywhere";

const markdown = "# Release Notes\n\n**Done** and _ready_.";

convertMarkdown(markdown, "whatsapp");
convertToSlack(markdown);

Exported Entry Points

• @sunanmau5/mdeverywhere
• @sunanmau5/mdeverywhere/browser-app
• @sunanmau5/mdeverywhere/markdown-parser
• @sunanmau5/mdeverywhere/converters/<name>

Supported Platforms

• WhatsApp
• Slack
• Discord
• Telegram
• Notion
• GitHub
• LinkedIn
• Plain Text
• HTML

Development

pnpm lint
pnpm test
pnpm check
pnpm format

Browser App Behavior

• Real-time conversion with a 300ms debounce
• Keyboard shortcuts: S focus platform, X clear, [ and ] switch platform, Cmd/Ctrl+Enter copy
• LocalStorage persistence of the latest input and selected platform
• Clipboard copy with a DOM selection fallback when navigator.clipboard is unavailable

Manual Test Samples

The repository includes demo/test-samples.md for quick manual spot checks in the demo app, but the primary quality gate is the automated test suite.

License

MIT