Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A Kanso package to quickly start using showdown.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 showdown
Octocat-spinner-32 README.md
Octocat-spinner-32 kanso.json
Octocat-spinner-32 showdown.js
README.md

Kanso Showdown

This package allows you to quickly start using Showdown in your Kanso project.

Install

Add to your project's kanso.json dependencies setting, here is the minimal case:

"dependencies": {
    "modules": null,
    "showdown": null
}

Run kanso install to fetch and install your package.

Usage

Require the module in your code and call makeHtml.

var showdown = require('showdown'),
    sd = new showdown.converter(),
    data = 'Markdown *helps* a lot.';

$('#content').html(sd.makeHtml(data));

Do a kanso push to build and deploy to your CouchDB:

kanso push http://localhost:5984/example

Docs

A good place to start is the showdown readme bundled in the package as showdown/README.md.

Maintenance

CommonJS Patch

Note the showdown.js library was modified slightly to be commonjs compatible.

< if (typeof module.exports != 'undefined') module.exports = Showdown;
---
> if (typeof exports != 'undefined') exports.Showdown = Showdown;
Something went wrong with that request. Please try again.