README.md
June 2, 2015 ยท View on GitHub
#Snowkit.docset This repository contains an offline api documention for Luxe, Snow, Nape, Gesluxe and the Haxe Std Lib.
| Library | Version |
|---|---|
| Haxe | 3.2.0 |
| Luxe | d0cd40f |
| Snow | d4d76b8 |
| Nape | dbe6663 |
| Gesluxe | d006820 |
Usage
-
Install Zeal (Windows, Linux), Dash (commercial, OS X) or Velocity (commercial, Windows)
-
Download snowkit.docset.zip
-
Unzip and move the folder snowkit.docset to
- zeal|windows: %LOCALAPPDATA%/Zeal/Zeal/docsets
- zeal|ubuntu: ~/local/share/zeal/docsets
- zeal|linux: See zeal settings window for docsets folder location
- dash|osx: See dash documentation
- velocity|windows: ~ %UserProfile%\AppData\Local\Silverlake Software LLC\Velocity
How to integrate Zeal in Flashdevelop
-
Setup Zeal as described above
-
Open Zeal Settings (File->Options)
-
Set Zeal to minimize to tray and hide to tray on window close so it does not need to restart everytime you need the documentation
-
Open Flashdevelops Settings (Tools->Program Settings)
-
Select the 'HaxeContext' on the left side
-
Change the value of 'Documentation Comand Line' to
C:\Program Files (x86)\Zeal\zeal.exe; $(ItmTypPkgName)
-
You can now press F1 when your cursor is over a Haxe Type to open the documentation
