slackify-markdown

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