Documentation

Sequelize for Dash

 

While getting one’s hands dirty with Sequelize, it can be useful to have access to the documentation, so even it’s relatively simple I decided to wrap the documentation for Sequelize in a docSet for Dash…

sequelize

Here is the link for the feed file…
Direct Link

…and here is the link for the custom URL for adding the feed to your Dash…
Add Feed Automatically

*** UPDATE ***
This is a 2.5 year old post, the links above are broken and not likely to come back online. Apologies for the inconvenience.

I recommend looking here for a working equivalent which is already registered as a curated member of the Dash user contribution sets:

https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/Sequelize#readme

Documentation

Bookshelf for Dash

In addition to the recent Moment and Async docSet for Dash, I have created a third docSet distribution, this time for the cool library Bookshelf which is pretty cool Node.js ORM for PostgreSQL, MySQL and SQLite3 in the style of Backbone.js.

bookshelf

Created by Tim Griesser, its just one project in the line of many which is solving every day issues with elegance and efficiency… Currently its the same approach as with Moment and Async, where its merely an embedded version of the online documentation…

bookshelf-dash

Add the documentation from here… Direct Link

Documentation

Moment.js for Dash

I have decided to add all the documentation I’m using to my setup for offline access, for this I’m using Dash (Dash is an API Documentation Browser and Code Snippet Manager).

Image

Dash is the same docSet standard used by Zeal (“…a simple offline API documentation browser inspired by Dash (OS X app), available for Linux and Windows”, http://zealdocs.org/).

Image

For my first docSet I chose to make the documentation for Moment.js available (a javascript date library for parsing, validating, manipulating, and formatting dates).

Image

Since the most laborious part of generating a docSet is adding all entries to the searchIndex database (an embedded SQLLite database), I opted for simply embedding the online documentation in an archive and expose it as the docSet in a single resource.

To install the docSet, simply client the link below and it will automatically add the reference to Dash (or Zeal):
Custom DashFeed URL for adding the docSet

If you prefer you can also add it manually by adding the following link to the list of docSets:
Direct URL to the docSet definition

Next step would be to create a script that would allow me to extract the different documentation points from the online documentation and add it to the searchIndex, however for now it fullfills my need to have an easy and structured way to access the documentation when offline.