jsdoc3-dash
v1.1.0
Published
Creates a [jsdoc3](https://github.com/jsdoc3/jsdoc3.github.com) docset for the source documentation browser, [Dash](http://kapeli.com/).
Downloads
6
Readme
jsdoc3-dash
Creates a jsdoc3 docset for the source documentation browser, Dash.
Building
The current jsdoc3 docset is in the build
directory. To rebuild the documentation:
> npm install
> jake build
This will pull the current master
branch from the jsdoc3 repository into a .tmp
directory and parse the source files to rebuild the docset.
Installing
From the jsdoc3 docset feed
- Open Dash
- Go to
Dash -> Preferences -> Downloads
and click the+
icon (Add docset feed) in the lower-left of the dialog - Enter the feed URL:
https://raw.github.com/nicholascloud/jsdoc3-dash/master/feeds/jsdoc3.xml
- Click the
Install
button when the docset appears in the dialog
When the docset is updated, the version number in the feed file will be incremented and you will receive the update automatically.
From github sources
Make sure Dash is installed and double-click on build/jsdoc3.docset
in Finder.
Alternatively:
- Open Dash
- Go to
Dash -> Preferences -> Docsets
and click the+
icon (Add Docset) in the lower-left of the dialog - Navigate to the project
build
directory - Choose the
jsdoc3.docset
directory to include in your Dash docsets