0.0.4 • Published 10 years ago
marked-middleware v0.0.4
markdown-middleware
middleware for serving markdown files as rendered HTML. It makes an effort to render a closely as possible to the style of github but stops short of actually using githubs API to keep performance snappy.
Installation
$ npm install markdown-middleware --save
then in your app:
var markdown = require('markdown-middleware')
Usage
just make sure you use
it before static or similar middleware
app.use(markdown({
// files will be looked for relative to
// to this path
directory: __dirname + '/public'
}))
For those contributing
before anything, just install the dependecies ...
$ npm install
Running the mocha tests
$ ./node_module/.bin/gulp test:mocha
Running the istanbul coverage
$ ./node_module/.bin/gulp test:istanbul
auto reloading watching
point your browser to localhost:3001/coverage
for auto-reloaded coverage page :)
$ npm install
$ ./node_module/.bin/gulp watch