jsdoc-docset-generator v0.1.0

JSDoc DocSet Generator

Generates a DocSet from html documentation. This generator has been primarly created to be used in correlation with jsDoc and the dash application. However it can be used completely on its own.

Installation

npm install jsdoc-docset-generator --save-dev

Usage

var DocSetGenerator = require('jsdoc-docset-generator').DocSetGenerator;
var docSetGenerator = new DocSetGenerator(
  {
    destination: "/path/to/dir",
    name: "MyDocSet",
    documentation: "/path/to/jsdoc/output"
  });
docSetGenerator.create();

Options

The DocSetGenerator constructor takes one parameter: new DocSetGenerator(configuration)

The configuration parameter is an object with the following keys.

• name: name of the docSet
• documentation: path to the html documentation
• destination: path to the directory in which you want to generate the docSet
• entries: Entries that will populate the docSet database optional
• icon: path to the docSet icon optional
• index: path to the index page of your html documentation optional, default to index.html
• platformFamily: will be used to fill the DocSetPlatformFamily attribute in the Info.plist file optional, falls back to the name
• identifier: will be used to fill the DocSetIdentifier attribute in the Info.plist file optional, falls back to the name

Entries

The entries parameter is an array of entries that will populate the sqlite3 database that comes with the docset.

Structure

Array<{ name:string, type:string, path:string }>

The type has to be one of the supported entry types.

This parameter is optional but without any entries, you won't get a neat overview of your documentation (list of classes, namespaces, methods and whatever else may be useful to you).