isabella232 / github-extension

Github MD flavor extension for Showdown

Showdown's Github Extension

---

IMPORTANT NOTICE

THIS EXTENSION IS DEPRECATED

As of showdown v 1.2.0, github support was moved into core as an opt-in feature making this extension obsolete. As such, this extension will not receive further updates.

---

Github extension for showdown

Adds support for github flavored markdown.

Installation

With npm

npm install showdown-github

With bower

bower install showdown-github

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-github.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: ['github']});

Example

var converter = new showdown.Converter({extensions: ['github']}),
    input = 'This is a ~~deleted text~~',
    html = converter.makeHtml(input);
    console.log(html);

This should output:

<p>This is a <del>deleted text</del></p>

License

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