Skip to content

Latest commit

 

History

History
43 lines (35 loc) · 1.81 KB

README.md

File metadata and controls

43 lines (35 loc) · 1.81 KB
Raw

DashDox

Build Status

Haxe API docset for Dash / Zeal.

Install to Dash

  1. Go to Dash's Preferences.
  2. Switch to the Downloads tab.
  3. Select User Contributed.
  4. Find the Haxe row and press the Download button.

Install to Zeal

  1. Tools -> Docsets.
  2. Click the Add feed button.
  3. Enter this feed URL: https://andyli.github.io/DashDox/haxe.xml
  4. Close. (It may tell you to wait, if so, wait a moment then click the close button again.)

Generate the docset

  1. Install Haxe.
  2. Build the haxe documentation by following the instruction of Dox.
  3. Clone this repo: git clone https://github.com/andyli/DashDox.git.
  4. Install the dependency: haxelib install build.hxml.
  5. Build the generation program: haxe build.hxml
  6. Run it: neko Main.n -name Haxe -html-doc path/to/dox/bin/pages -xml-doc path/to/dox/bin/xml -icon haxe.png -out . -clean

CC0 To the extent possible under law, Andy Li has waived all copyright and related or neighboring rights to Haxe API docset generator. This work is published from: Hong Kong.