slack-hawk-down

Render Slack flavored markdown as HTML

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
slack-hawk-down
4120.5.35 years ago7 years agoMinified + gzip package size for slack-hawk-down in KB

Readme

Slack Hawk Down
The current up-to-date repo for Slack-flavored markdown as HTML
https://www.npmjs.com/package/slack-hawk-down

Installation

npm install --save slack-hawk-down

Usage

Render universal Slack markdown as HTML

import { escapeForSlack, escapeForSlackWithMarkdown } from 'slack-hawk-down'

escapeForSlack(':wave:') // => 'Ґ'
escapeForSlackWithMarkdown('`this is a code block`) // => '<span class="slack_code">this is a code block</span>'

You can view the rest of the markdown styles here

Replace Slack user IDs with user names

escapeForSlack('<@U123|david> did you see my pull request?', { users: { 'U123': 'david', ... } }) // => '@david did you see my pull request?'
You can get a list of the users in your Slack team by requesting this endpoint with a users:read scope

Replace Slack channel IDs with channel names

escapeForSlack('<#C123> please fill out this poll', { channels : { '#C123': 'general', ... } }) // => '#general please fill out this poll'
You can get a list of the users in your Slack team by requesting this endpoint with a channels:read scope

Replace Custom Slack emojis

escapeForSlack(':facepalm:', { customEmoji: { facepalm: 'http://emojis.slackmojis.com/emojis/images/1450319441/51/facepalm.png', ... } }) // => '<img alt="facepalm" src="http://emojis.slackmojis.com/emojis/images/1450319441/51/facepalm.png" />'
You can get a list of custom emoji for your Slack team by requesting this endpoint with a emoji:read scope

Replace subteam names (for paid accounts)

escapeForSlack('<!subteam^S123>', { usergroups: { 'S123': 'swiftype-eng', ...} }) // => 'swiftype-eng'
You can get a list of user groups for your Slack team by requesting this endpoint with a usergroups:read scope

Testing

yarn test

Upcoming

  • Customizeable element and class names for markdown elements

Contribution

Please open a pull request or issue

License

MIT