Skip to content

jsarafajr/slackify-markdown

Repository files navigation

Slackify-Markdown

Build Status codecov Known Vulnerabilities

Slackify-Markdown is a Markdown to Slack-specific-markdown converter, based on Unified and Remark.

Requirements

  • Node.js 22 or higher
  • ESM-only package (see Usage for details)

Install

npm install slackify-markdown

Usage

This package is ESM only. For CommonJS, use v4.x version of the package.

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>
*/

About

Convert markdown into Slack-specific markdown

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 14