Markdown Stripper

A lightweight, zero‑dependency TypeScript utility to strip Markdown formatting from a string. Fully typed and customizable.

🔧 Installation

npm install markdown-stripper
# or
yarn add markdown-stripper

Dev Dependencies

npm install --save-dev typescript jest ts-jest @types/jest

🚀 Usage

import markdownStripper, { MarkdownStripperOptions } from 'markdown-stripper';

const md = `
# Hello **World**

- Item 1
- Item 2
`;

// Basic
console.log(markdownStripper(md));
// Output:
// Hello World
// Item 1
// Item 2

// With options
const opts: MarkdownStripperOptions = {
  listUnicodeChar: '•',
  replaceLinksWithURL: true,
};
console.log(markdownStripper(md, opts));

⚙️ API

markdownStripper(md: string, opts?: MarkdownStripperOptions): string

| Option | Type | Default | Description | |-----------------------|----------------|-----------|-------------------------------------------------------------------------------| | listUnicodeChar | string \| false | false | Replace list bullets (-, *, +, or numbered) with this character. | | stripListLeaders | boolean | true | Remove leading list markers (preserves indentation). | | gfm | boolean | true | Strip GFM features: setext headers, fenced code blocks, strikethrough. | | useImgAltText | boolean | true | Keep the alt text of images instead of dropping the entire tag. | | abbr | boolean | false | Remove Markdown abbreviation definitions. | | replaceLinksWithURL | boolean | false | If true, replaces link text with its URL; otherwise keeps link text. | | htmlTagsToSkip | string[] | [] | List of HTML tags (e.g. ['sub']) to preserve while stripping others. | | throwError | boolean | false | Throw on internal errors instead of returning the raw input. |