0.3.0 • Published 4 years ago
docset-generator v0.3.0
DocSet Generator
Generates a docSet from html documentation.
Installation
npm install docset-generator --save
Usage
var DocSetGenerator = require('docset-generator').DocSetGenerator;
var docSetGenerator = new DocSetGenerator(
{
destination: "/path/to/dir",
name: "MyDocSet",
documentation: "/path/to/html"
});
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 docSetdocumentation
: path to the html documentationdestination
: path to the directory in which you want to generate the docSet optional, falls back to the documentation folderenableJavascript
: boolean, enable Javascript in the generated docSetentries
: Entries that will populate the docSet database optionalicon
: path to the docSet icon optionalindex
: path to the index page of your html documentation optional, default to index.htmlplatformFamily
: will be used to fill the DocSetPlatformFamily attribute in the Info.plist file optional, falls back to the nameidentifier
: 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). You can use jsdoc-docset to generate those entries from inside your jsdoc template.