lout

API documentation generator plugin for hapi

npm install lout
56 downloads in the last day
236 downloads in the last week
1 222 downloads in the last month

lout Logo

API documentation generator for hapi

Build Status Dependencies Status DevDependencies Status

lout is a documentation generator for hapi servers, providing a human-readable guide for every endpoint using the route configuration. The module allows full customization of the output.

lout requires that the plugin is granted the 'routes' and 'views' permissions.

The following options are available when registering the plugin:

  • 'engines' - an object where each key is a file extension (e.g. 'html', 'jade'), mapped to the npm module name (string) used for rendering the templates. Default is { html: 'handlebars' }.
  • 'endpoint' - the path where the route will be registered. Default is /docs.
  • 'basePath' - the absolute path to the templates folder. Default is the lout templates folder.
  • 'cssPath' - the absolute path to the css folder. Default is the lout css folder. It must contain a style.css.
  • 'helpersPath' - the absolute path to the helpers folder. Default is the lout helpers folder. This might need to be null if you change the basePath.
  • 'auth' - the route configuration for authentication. Default is to disable auth.
  • 'indexTemplate' - the name of the template file to contain docs main page. Default is 'index'.
  • 'routeTemplate' - the name of the route template file. Default is 'route'.

Usage

var Hapi = require('hapi');
var server = new Hapi.Server(80);

server.pack.route([{
    your routes...
}]);

server.pack.require('lout', function() {
    server.start();
});
npm loves you