Permalink
Browse files

first commit

  • Loading branch information...
0 parents commit e82a50b0da5a118510963a21e77f98079434624a @mandric committed Jan 18, 2012
@@ -0,0 +1,54 @@
+# Kanso Showdown
+
+This package allows you to quickly start using
+[Showdown](https://github.com/coreyti/showdown/) in your Kanso project.
+
+## Install
+
+Add to your project's kanso.json dependencies setting, here is the minimal
+case:
+
+```json
+"dependencies": {
+ "modules": null,
+ "showdown": null
+}
+```
+
+Run `kanso install` to fetch and install your package.
+
+## Usage
+
+Require the module in your code and call makeHtml.
+
+```javascript
+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 original showdown package's readme bundled in
+`packages/showdown/showdown/README.md`.
+
+## Maintenance
+
+### CommonJS Patch
+
+*Note* the showdown.js library was modified slightly to be commonjs compatible.
+
+```diff
+< if (typeof module.exports != 'undefined') module.exports = Showdown;
+---
+> if (typeof exports != 'undefined') exports.Showdown = Showdown;
+```
+
@@ -0,0 +1,17 @@
+{
+ "name": "showdown",
+ "version": "0.0.2",
+ "url": "https://github.com/mandric/kanso-showdown",
+ "categories": ["parsers"],
+ "maintainers": [
+ {
+ "name": "Milan Andric",
+ "url": "http://m.andric.us"
+ }
+ ],
+ "description": "A javascript port of Markdown.",
+ "modules": "showdown.js",
+ "dependencies": {
+ "modules": ">=0.0.8"
+ }
+}
Oops, something went wrong.

0 comments on commit e82a50b

Please sign in to comment.