Skip to content

showdownjs/twitter-extension

Repository files navigation

Showdown's Twitter Extension

Build Status npm version npm version


Twitter extension for showdown

Adds support for:

@username   ->  <a href="http://twitter.com/username">@username</a>
#hashtag    ->  <a href="http://twitter.com/search/%23hashtag">#hashtag</a>

Installation

With npm

npm install showdown-twitter

With bower

bower install showdown-twitter

Manual

You can also download the latest release zip or tarball and include it in your webpage, after showdown:

<script src="showdown.min.js">
<script src="showdown-twitter.min.js">

Enabling the extension

After including the extension in your application, you just need to enable it in showdown.

var converter = new showdown.Converter({extensions: ['twitter']});

Example

var converter = new showdown.Converter({extensions: ['twitter']}),
    input = 'This is a tweet from @showdownjs with the hashtag #showdownRules',
    html = converter.makeHtml(input);
    console.log(html);

This should output:

<p>This is a tweet from <a href="http://twitter.com/showdownjs">@showdownjs</a> with the hashtag <a href="http://twitter.com/search/%23showdownRules">#showdownRules</a></p>

License

These files are distributed under BSD license. For more information, please check the LICENSE file in the source code.

About

Twitter extension for Showdown

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •