Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/bartkmq/Snowkit.docset

Docsets for Snowkit for Zeal (Windows, Linux) and Dash (OS X)
https://github.com/bartkmq/Snowkit.docset

Last synced: 3 months ago
JSON representation

Docsets for Snowkit for Zeal (Windows, Linux) and Dash (OS X)

Host: GitHub
URL: https://github.com/bartkmq/Snowkit.docset
Owner: bartkmq
Created: 2015-06-02T13:13:15.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2019-07-23T01:02:33.000Z (almost 5 years ago)
Last Synced: 2024-04-13T20:09:49.661Z (3 months ago)
Size: 5.26 MB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Lists

awesome-snowkit - snowkit docset

README

        #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)

  - [Zeal](http://zealdocs.org/)

  - [Dash](https://kapeli.com/dash)

  - [Velocity](http://velocity.silverlakesoftware.com/)

- **Download** [snowkit.docset.zip](Snowkit.docset.zip?raw=true)

- **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

  

  ![](images/zeal_docsets_folder.PNG)

## 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

  ![](images/zeal_options.PNG)

- Open Flashdevelops Settings (Tools->Program Settings)

- Select the 'HaxeContext' on the left side

- Change the value of 'Documentation Comand Line' to

```bash

C:\Program Files (x86)\Zeal\zeal.exe; $(ItmTypPkgName)

```

  ![](images/zeal_flashdevelop_settings.PNG)

    

- You can now press F1 when your cursor is over a Haxe Type to open the documentation

  ![](images/zeal_flashdevelop_cursor.png)

  

  ![](images/zeal_flashdevelop_zeal_open.PNG)

[Haxe]: https://github.com/HaxeFoundation/haxe

[Luxe]: https://github.com/underscorediscovery/luxe

[Snow]: https://github.com/underscorediscovery/snow

[Nape]: https://github.com/deltaluca/nape

[Gesluxe]: https://github.com/josuigoa/gesluxe

[Rainbow]: https://github.com/Dvergar/rainbow