# remove-markdown

> Remove Markdown formatting from text

Latest version **0.7.0** (published 2026-08-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install remove-markdown
pnpm add remove-markdown
yarn add remove-markdown
bun add remove-markdown
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.7.0 |
| Published | 2026-08-31 |
| First published | 2015-02-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 376 |
| Author | Stian Grytøyr |
| Maintainers | stiang, zuchka |
| Keywords | markdown |

## Links

- npm: https://www.npmjs.com/package/remove-markdown
- Repository: https://github.com/zuchka/remove-markdown
- Issues: https://github.com/zuchka/remove-markdown/issues
- npm.io page: https://npm.io/package/remove-markdown

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.7.0 (latest) — 2026-08-31
- 0.7.0-rc.1 (next) — 2026-08-26
- 0.7.0-rc.0 — 2026-08-25
- 0.6.4 — 2026-05-09
- 0.6.3 — 2026-01-15
- 0.6.2 — 2025-05-02
- 0.6.1 — 2025-05-02
- 0.6.0 — 2024-12-16
- 0.5.5 — 2024-09-01
- 0.5.4 — 2024-09-01
- 0.5.3 — 2024-08-29
- 0.5.2 — 2024-08-02
- 0.5.0 — 2022-04-27
- 0.3.0 — 2018-05-27
- 0.2.2 — 2017-08-12
- … 8 more at https://npm.io/package/remove-markdown/versions

## README

[![npm version](https://img.shields.io/npm/v/remove-markdown.svg)](https://www.npmjs.com/package/remove-markdown)
[![npm downloads](https://img.shields.io/npm/dm/remove-markdown.svg)](https://npm-compare.com/remove-markdown/#timeRange=THREE_YEARS)
[![GitHub Actions Build Status](https://github.com/zuchka/remove-markdown/actions/workflows/default.yaml/badge.svg)](https://github.com/zuchka/remove-markdown/actions/workflows/default.yaml)

## What is it?
**remove-markdown** is a JavaScript module that removes (strips) Markdown formatting from text. It supports CommonJS and ES modules in Node.js, plus Deno through npm compatibility.
*Markdown formatting* means pretty much anything that doesn’t look like regular text, like square brackets, asterisks etc.

## When do I need it?
The typical use case is to display an excerpt from some Markdown text, without any of the actual Markdown syntax - for example in a list of posts.

## Installation

```sh
npm install remove-markdown
```

## Usage

### CommonJS

```js
const removeMd = require('remove-markdown');
const markdown = '# This is a heading\n\nThis is a paragraph with [a link](http://www.disney.com/) in it.';
const plainText = removeMd(markdown); // plainText is now 'This is a heading\n\nThis is a paragraph with a link in it.'
```

### Node.js ES modules

```js
import removeMd from 'remove-markdown';

const markdown = '# This is a heading\n\nThis is a paragraph with [a link](http://www.disney.com/) in it.';
const plainText = removeMd(markdown);
```

### Browser ES modules

The ESM entry is self-contained and can be loaded directly from a CDN that
serves JavaScript with the correct MIME type. Pin the URL to the version you
have tested:

```html
<script type="module">
  import removeMd from 'https://unpkg.com/remove-markdown@0.7.0/index.mjs';

  const plainText = removeMd('# This is a heading');
</script>
```

### Deno

```js
import removeMd from 'npm:remove-markdown@^0.7.0';

const markdown = '# This is a heading\n\nThis is a paragraph with [a link](http://www.disney.com/) in it.';
const plainText = removeMd(markdown);
```

Deno support is provided through the npm package; there is no separate JSR package. The package exposes one callable default export in every runtime. Named exports and direct imports from raw GitHub URLs, which do not reliably serve the correct JavaScript MIME type, are not supported.

You can also supply an options object to the function. Currently, the following options are supported:

```js
const plainText = removeMd(markdown, {
  stripListLeaders: true ,     // strip list leaders (default: true)
  listUnicodeChar: '',         // char to insert instead of stripped list leaders (default: '')
  gfm: true,                   // support GitHub-Flavored Markdown (default: true)
  useImgAltText: true,         // replace images with alt-text, if present (default: true)
  abbr: true,                  // remove abbreviations, if present (default: false)
  replaceLinksWithURL: true,   // remove inline links, if present (default: false)
  separateLinksAndTexts: ': ', // replace inline links with text, separator and link, if present (default: null)
  htmlTagsToSkip: ['a', 'b'],  // HTML tags to skip, if present (default: [])
  throwError: false,           // throw errors instead of catching and logging (default: false)
});
```

Setting `stripListLeaders` to false will retain any list characters (`*, -, +, (digit).`).

## TODO
PRs are very much welcome. Here are some ideas for future enhancements:

* Allow the RegEx expressions to be customized per rule
* Make the rules more robust, support more edge cases
* Add more (comprehensive) tests

## Credits
The code is based on [Markdown Service Tools - Strip Markdown](http://brettterpstra.com/2013/10/18/a-markdown-service-to-strip-markdown/) by Brett Terpstra.

## Authors
Stian Grytøyr (original creator)
[zuchka](https://github.com/zuchka) (maintainer since 2023)

---
_Source: https://npm.io/package/remove-markdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
