# slackify-markdown

> Convert markdown into Slack-specific markdown

Latest version **5.0.0** (published 2025-11-07) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2025-11-07 |
| First published | 2018-03-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=22 |
| Dependencies | 7 |
| Unpacked size | 29 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 176 |
| Author | Yevhenii Baraniuk |
| Maintainers | jsarafajr |
| Keywords | slack, markdown, slackify, parser, remark, unified, esm, typescript |

## Links

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

## Dependencies (7)

- [unified](https://npm.io/package/unified.md) ^11.0.5
- [remark-gfm](https://npm.io/package/remark-gfm.md) ^4.0.0
- [remark-parse](https://npm.io/package/remark-parse.md) ^11.0.0
- [remark-stringify](https://npm.io/package/remark-stringify.md) ^11.0.0
- [unist-util-visit](https://npm.io/package/unist-util-visit.md) ^5.0.0
- [unist-util-remove](https://npm.io/package/unist-util-remove.md) ^4.0.0
- [mdast-util-to-markdown](https://npm.io/package/mdast-util-to-markdown.md) ^2.1.2

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 5.0.0 (latest) — 2025-11-07
- 4.5.0 — 2025-06-19
- 4.4.0 — 2023-08-18
- 4.3.1 — 2021-12-07
- 4.3.0 — 2021-05-12
- 4.2.0 — 2021-05-12
- 4.1.0 — 2021-01-19
- 4.0.0 — 2020-12-30
- 3.1.0 — 2020-10-20
- 3.0.3 — 2020-06-06
- 3.0.1 — 2020-06-06
- 2.1.0 — 2019-09-18
- 2.0.3 — 2019-09-18
- 2.0.2 — 2019-09-18
- 2.0.1 — 2019-09-18
- … 7 more at https://npm.io/package/slackify-markdown/versions

## README

# Slackify-Markdown

![Build Status](https://github.com/jsarafajr/slackify-markdown/actions/workflows/build.yml/badge.svg)
[![codecov](https://codecov.io/gh/jsarafajr/slackify-markdown/branch/master/graph/badge.svg)](https://codecov.io/gh/jsarafajr/slackify-markdown) [![Known Vulnerabilities](https://snyk.io/test/github/jsarafajr/slackify-markdown/badge.svg)](https://snyk.io/test/github/jsarafajr/slackify-markdown)

Slackify-Markdown is a Markdown to [Slack-specific-markdown](https://api.slack.com/docs/message-formatting#message_formatting) converter, based on [Unified](https://github.com/unifiedjs/unified) and [Remark](https://github.com/remarkjs/remark/).

## Requirements

- Node.js 22 or higher
- ESM-only package (see [Usage](#usage) for details)

## Install

```bash
npm install slackify-markdown
```

## Usage

This package is [ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) only. For CommonJS, use v4.x version of the package.

```js
import { slackifyMarkdown } from 'slackify-markdown';

const markdown = `
# List of items

* item 1
* item 2
* item 3

[here is an example](https://example.com)
`;

const result = slackifyMarkdown(markdown);
console.log(result);
/*
 *List of items*

 • item 1
 • item 2
 • item 3

 <https://example.com|here is an example>
*/
```

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