Metalsmith annotate

Metalsmith Annotate is a MetalSmith plugin for creating html files from code annotation. It is based on docco library and it has been designed to parse only js files.

Installation

To install Metalsmith Annotate, simply use npm:

npm install metalsmith-annotate --save

Usage

You can see an example of usage in test folder. Metalsmith Annotate has two params that needs to be passed:

• directory: is a string containing the relative path where docco need to look for js source code files that need to be parsed
• workingdir: is a tring containing the absolute path where docco can create a temporary folder for parsed files

'use strict'
 
var metalsmith = require('metalsmith'),
    annotate = require('metalsmith-annotate')
 
// directory param is where docco needs to look for js source file. 
// workingdir param is where the module is going to create temp folder for html files.
metalsmith.use(annotate({
      directory: '',
      workingdir: __dirname
    }))

License

Copyright Michele Capra 2015, Licensed under MIT