https://github.com/andyli/dashdox

Haxe API Dash docset.
https://github.com/andyli/dashdox

api-docset dash dash-docset docset haxe zeal

Last synced: 28 days ago
JSON representation

Haxe API Dash docset.

• Host: GitHub
• URL: https://github.com/andyli/dashdox
• Owner: andyli
• Created: 2014-04-18T20:39:54.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2019-03-31T23:26:07.000Z (over 5 years ago)
• Last Synced: 2024-04-14T22:16:46.375Z (7 months ago)
• Topics: api-docset, dash, dash-docset, docset, haxe, zeal
• Language: Haxe
• Homepage: dash-feed://https%3A%2F%2Fandyli.github.io%2FDashDox%2Fhaxe.xml
• Size: 14.1 MB
• Stars: 12
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# DashDox

[![Build Status](https://travis-ci.org/andyli/DashDox.svg?branch=master)](https://travis-ci.org/andyli/DashDox)

[Haxe](https://haxe.org/) API docset for [Dash](https://kapeli.com/dash) / [Zeal](https://zealdocs.org/).

## 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](https://haxe.org/).

  2. Build the haxe documentation by following the instruction of [Dox](https://github.com/HaxeFoundation/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`



  

    

  

  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.