express-middleware-readme.md

Expose github style README.md as an endpoint using middleware

npm install express-middleware-readme.md
6 downloads in the last day
23 downloads in the last week
53 downloads in the last month

express-middleware-readme.md

Express middleware which parses your project root's README.md to HTML and exposes on a specified URL.

Build Status

Usage

Default Options

app.use(require('express-middleware-readme.md').run)

This will expose your README.md at the the path '/readme.md'.

Set options

var readme = require('express-middleware-readme.md')
readme.setOptions({
    endpoint: [ '/readme.md', '/README.html' ],
    htmlWrap: {
        scripts: '/js/main.js',
        styles: '/css/style.css',
        meta: [
            { charset: 'utf-8' }
        ],
        title: 'This is my github README.md'
    }
})
app.use(readme.run)

Notes:

  • Each of 'endpoint', 'scripts', and 'styles' can be string values or arrays
  • An empty object as 'htmlWrap' results in just doctype, html, head, and body tags added
  • 'meta' can be made up of 'content', 'charset', 'http-equiv', and 'name' attributes
  • 'filename' is the location of your README.md relative to project root (defaults to ./README.md)
  • 'endpoint' defaults to '/readme.html'

License

Apache 2.0, please let me know if this doesn't suit :-)

To-do

Add tests, all code is crap without.

This will be a good little project for me to translate my unit testing skills over to node.js/javascript.

npm loves you