Expressjs middleware for rendering markdown files
JavaScript
Switch branches/tags
Nothing to show
Permalink
Failed to load latest commit information.
lib
.gitignore
LICENSE Updated license date Sep 8, 2013
README.md Updated readme Dec 31, 2012
package.json Incremented package version Dec 6, 2013

README.md

express-markdown

Express middleware for rendering markdown files

It looks for URLs ending in ".md" or ".markdown", example: http://mysite.com/README.md

Installation

npm install express-markdown

Usage

// !!!IMPORTANT: place this before static or similar middleware
app.use(require('express-markdown')({

  // directory where markdown files are stored
  // required
  directory: __dirname + '/public', 

  // view to use for rendering markdown file
  // optional
  // default is undefined, no view
  view: 'foo',

  // name of markdown variable passed in the context when rendering
  // optional
  // default 'markdown'
  variable: 'bar'

}));