@clearfeed-ai/slack-to-html 1.0.0

package/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["es2015", "babili"]
+}

package/.nvmrc

@@ -0,0 +1 @@
+6.5.0

package/README.md

@@ -0,0 +1,64 @@
+# Slack to HTML
+
+Forked originally from https://github.com/swiftype/slack-hawk-down
+
+Slack markdown to HTML
+
+## Installation
+```
+npm install --save slack-to-html
+```
+
+## 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](https://get.slack.help/hc/en-us/articles/202288908-Format-your-messages)
+
+### 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](https://api.slack.com/methods/users.list) 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](https://api.slack.com/methods/channels.list) 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](https://api.slack.com/methods/emoji.list) 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](https://api.slack.com/methods/usergroups.list) with a `usergroups:read` scope
+
+## Testing
+
+```
+npm test
+```
+
+## Upcoming
+- Customizeable element and class names for markdown elements
+
+## Contribution
+Please open a pull request or issue
+
+## License
+MIT