# markdown-escape

> escape Markdown control characters

Latest version **2.0.0** (published 2022-11-16) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2022-11-16 |
| First published | 2015-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/markdown-escape) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 18 |
| Author | Kyle E. Mitchell |
| Maintainers | kemitchell |
| Keywords | Markdown, escape, string |

## Links

- npm: https://www.npmjs.com/package/markdown-escape
- Repository: https://github.com/kemitchell/markdown-escape.js
- Homepage: https://github.com/kemitchell/markdown-escape.js#readme
- Issues: https://github.com/kemitchell/markdown-escape.js/issues
- npm.io page: https://npm.io/package/markdown-escape

## 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

- 2.0.0 (latest) — 2022-11-16
- 1.1.0 — 2020-05-21
- 1.0.2 — 2017-05-26
- 1.0.1 — 2015-07-19
- 1.0.0 — 2015-07-19

## README

Escape Markdown control characters.

```javascript
var escape = require('markdown-escape')
var assert = require('assert')

assert(escape("#1! We're #1!") === "\\#1! We're \\#1!")
assert(escape("http://example.com") === 'http:\\/\\/example.com')
assert(escape('one (1)') === 'one \\(1\\)')

// Skip escaping specific characters.
assert(escape('one (1)', ['parentheses']) === 'one (1)')
assert(escape("http://example.com", ['slashes']) === 'http://example.com')
```

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