/Dash-Docset-Creator

A simple PHP script to turn multiple HTML files into a .docset compatible with Dash

Primary LanguagePHP

Dash Docset Creator

Generate .docset 's from induvidial HTML files that are compatible with the amazing Dash App for Mac

Instructions

  1. Download / Extract Source to directory of your choosing
  2. Place all HTML files into the files_go_here dir
  3. Place an Icon (icon.png) into the icon_goes_in_here dir
  4. Create an empty <strong<output dir
  5. Now edit the docset.config.php file
/*DOCSET FILENAME*/
/*MUST END WITH .docset !!!*/
$config['docset_filename'] = 'myname.docset';

/*DOCSET TITLE*/
$config['docset_title'] = 'My Documentation';

/*DOCSET PRETTYNAME (SINGLE WORD)*/
$config['docset_prettyname'] = 'MyName';

/*DOCSET INDEX PAGE*/
$config['docset_index_page'] = 'index.html';

/*DOCSET DOCSEUTIL PATH*/
$config['docset_docseutil_path'] = '/Applications/Xcode.app/Contents/Developer/usr/bin/docsetutil';

####Now from the command line (Terminal) run: Note: run in project directory

php create-docset.php

#####The .docset should now show up in the "output" folder!