Git Product home page Git Product logo

slackdown's Introduction

Slackdown

Slackdown is a simple javascript parser for translating messages from the slack.com API into html.

Basic formatting like bold, italic, underscore, fixed width and slack.com <> tags are supported. See TODO for unsupported formatting.

The parser is intended to be used when you want to display messages from slack.com on an html page. The parser can not translate message from html to slack format. The script is stand alone and does not use jQuery or any other frameworks (except for testing).

Formatting-rules are found here https://api.slack.com/docs/formatting

Usage

Including

In Browser:

<script src="slackdown.min.js"></script>

With Require.js:

define(['slackdown'], function(slackdown) {
    //Your code
});

With Node.js

var slackdown = require('slackdown');

Slackdown is not published as a npm package. Include by github reference.

{
  "dependencies": {
    "slackdown": "blockmar/slackdown"
  }
}

Parsing text

var html = slackdown.parse("This is a text from <http://slack.com|Slack>");

Testing

Tests are runmed using QUnit. Open test/index.html in your browser. Dependencies are handled using Bower.

Build/Distribute

The minified version of Slackdown is created by a Grunt-task using uglify.

TODO

Known bugs

  • None right now

slackdown's People

Contributors

blockmar avatar

Watchers

James Cloos avatar Kevin Cramer avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.