Skip to content

JamesHight/express-markdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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'

}));

About

Expressjs middleware for rendering markdown files

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published