slackify-markdown

What is slackify-markdown?

The slackify-markdown npm package is designed to convert Markdown syntax into Slack's message formatting. This allows developers to write messages in Markdown and then easily convert them to a format that can be used in Slack messages.

What are slackify-markdown's main functionalities?

Basic Markdown to Slack Conversion

This feature allows you to convert basic Markdown syntax into Slack's message formatting. The example converts a Markdown string with a header and italic text into a Slack-compatible format.

const slackifyMarkdown = require('slackify-markdown');
const markdown = '# Hello World\nThis is a *test* message.';
const slackMessage = slackifyMarkdown(markdown);
console.log(slackMessage);

Handling Links

This feature converts Markdown links into Slack's link format. The example converts a Markdown link to Google into a Slack-compatible link.

const slackifyMarkdown = require('slackify-markdown');
const markdown = '[Google](https://www.google.com)';
const slackMessage = slackifyMarkdown(markdown);
console.log(slackMessage);

Lists Conversion

This feature converts Markdown lists into Slack's list format. The example converts a Markdown unordered list into a Slack-compatible list.

const slackifyMarkdown = require('slackify-markdown');
const markdown = '- Item 1\n- Item 2\n- Item 3';
const slackMessage = slackifyMarkdown(markdown);
console.log(slackMessage);

Other packages similar to slackify-markdown

marked

Marked is a low-level Markdown compiler that allows for extensive customization. While it does not specifically target Slack formatting, it can be extended to do so with custom renderers.

showdown

Showdown is a bidirectional Markdown to HTML converter. Like marked, it does not specifically target Slack formatting but can be customized to achieve similar results.

markdown-it

Markdown-it is a fast and flexible Markdown parser. It offers plugins and can be extended to support custom formats, including Slack's message formatting.

README

Slackify-Markdown

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

Install

npm install slackify-markdown

Usage

const slackifyMarkdown = require('slackify-markdown');
const markdown = `
# List of items

* item 1
* item 2
* item 3

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

slackifyMarkdown(markdown);
/*
 *List of items*

 • item 1
 • item 2
 • item 3

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

Emojis

Emojis map can be passed through options to replace some specific emoji codes

const options = {
  emojis: { ':hello:': ':bye:' }
};

slackifyMarkdown(':hello: my fried!', options); // -> ':bye: my friend!'

Copyright and License

Copyright Yevhenii Baraniuk, 2018

MIT Licence