Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A very basic template for rendering an html page based on the dox library

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 node_modules
Octocat-spinner-32 index.html
Octocat-spinner-32 index.js
Octocat-spinner-32 package.json
Octocat-spinner-32 readme.md
Octocat-spinner-32 template.html
Octocat-spinner-32 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"}

Something went wrong with that request. Please try again.