Sophisticated JavaScript documentation engine. Create beautiful, articulate, multi-versioned documentation. (new site coming soon)
Install
> npm install documentjs -S
Configure documentjs.json
{ "sites": { "docs": { "glob" : "**/*.{js,md}" } } }
Document with tags
/** * @module {function(new:lib/graph)} lib/graph * * @signature `new Graph(graphData)` * @param {Object} graphData * @return {lib/graph} */ function Graph(graphData){ … } /** * @prototype */ Graph.prototype = { /** * Converts the graph to a chart. * @param {String} type */ toChart: function(type){ ... } }; module.exports = Graph;
Generate your docs and watch for changes
> ./node_modules/.bin/documentjs --watch
Sophisticated JavaScript documentation engine. Create beautiful, articulate, multi-versioned documentation.
(new site coming soon)
Install
Configure documentjs.json
Document with tags
Generate your docs and watch for changes