A very basic template for rendering an html page based on the dox library
Pull request Compare This branch is 2 commits behind jepso:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
node_modules
index.html
index.js
package.json
readme.md
template.html
template.md

readme.md

Dox Basic

Example Usage

npm install dox-basic -g
dox-basic -t "Library Name"<index.js>readme.html
dox-basic -m -t "Library Name"<index.js>readme.md 

exports.name

Parser name

exports.version

Parser version

exports.parse()

Parse source code to produce documentation

@param {string} source JavaScript source code with comments
@param {object} [options]
@param {string} [options.title] The title of the javascript library
@param {bool} [options.md] If true, render a markdown output rather than html
@return {string} undefined An html representation of the documentation

exports.parseInner()

Parse source code to produce documentation without the surrounding html page

@param {string} source JavaScript source code with comments
@param {object} [options]
@return {object} undefined {html:"HTML representation of docs", css:"link to a css style sheet to include"}