https://github.com/suttna/botbuilder-markdown

Convert markdown to channel specific format. Pluggable middleware.
https://github.com/suttna/botbuilder-markdown

bot botbuilder botframework markdown msteams parser slack

Last synced: 1 day ago
JSON representation

Convert markdown to channel specific format. Pluggable middleware.

• Host: GitHub
• URL: https://github.com/suttna/botbuilder-markdown
• Owner: suttna
• Created: 2017-10-10T22:47:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-01-23T17:23:39.000Z (3 days ago)
• Last Synced: 2025-01-23T18:27:35.890Z (3 days ago)
• Topics: bot, botbuilder, botframework, markdown, msteams, parser, slack
• Language: TypeScript
• Homepage: https://suttna.com
• Size: 128 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![Logo](logo.png)

# botbuilder-markdown [![npm version](https://badge.fury.io/js/botbuilder-markdown.svg)](https://badge.fury.io/js/botbuilder-markdown) [![CircleCI](https://circleci.com/gh/suttna/botbuilder-markdown.svg?style=svg)](https://circleci.com/gh/suttna/botbuilder-markdown) [![codecov](https://codecov.io/gh/suttna/botbuilder-markdown/branch/master/graph/badge.svg)](https://codecov.io/gh/suttna/botbuilder-markdown) [![Join the chat at https://gitter.im/suttna/botbuilder-markdown](https://badges.gitter.im/suttna/botbuilder-markdown.svg)](https://gitter.im/suttna/botbuilder-markdown?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

⚠️  **This is under development. If you want to help 🚀, please contact the Suttna team at [email protected]**

Slack middleware for Microsoft BotBuilder.

This middleware was created at [Suttna](https://suttna.com) to tackle some of the limitations of BotFramework's current text parser.

## Install

```

yarn add botbuilder-markdown

```

## Usage

```javascript

import * as restify from 'restify'

import { UniversalBot, IEvent, IIdentity } from "botbuilder"

import { ChatConnector } from "botbuilder"

import { markdownMiddleware } from "botbuilder-markdown"

const connector = new ChatConnector({

  appId: process.env.MICROSOFT_APP_ID,

  appPassword: process.env.MICROSOFT_APP_PASSWORD

})

const bot = new UniversalBot(connector)

const server = restify.createServer()

server.listen(3000, () => {

  console.log("Bot is listening...")

})

// You just need to add the middleware and then you will be able to send/receive messages with markdown

bot.use(markdownMiddleware)

bot.dialog('/', (session) => {

  session.endDialog('pong')

})

server.post('/api/messages', connector.listen())

```

## Help

If you want to help on improving this package, please contact us at [email protected].

## Contact

- Martín Ferández 

- Santiago Doldán