Fork 0

Pony documentation as Dash docset

JavaScript 98.7%
Makefile 1.3%

Find a file

ergl ab7312ca68 Bump		2018-05-28 15:01:34 +02:00
docs	Update ponydocs	2018-05-28 00:42:08 +02:00
src	Parse public fields correctly	2018-05-28 14:55:38 +02:00
.gitignore	Initial commit	2018-03-25 22:39:32 +02:00
.gitmodules	Initial commit	2018-03-25 22:39:32 +02:00
LICENSE	Initial commit	2018-03-25 22:39:32 +02:00
Makefile	Update parsing for new docs theme	2018-05-28 00:43:21 +02:00
package-lock.json	Add dep target, lock file	2018-05-27 19:21:50 +02:00
package.json	Goodbye bash, we hardly knew ye	2018-03-28 23:22:03 +02:00
README.md	Bump	2018-05-28 15:01:34 +02:00

README.md

Pony Docset

Latest revision: Pony 0.22.2 | Download docset

Pony is an "object-oriented, actor-model, capabilities-secure, high-performance programming language". I found the original online documentation a bit cumbersome to use, so I created this docset.

Dash is an API Documentation Browser and Code Snippet Manager for Mac. If you are using Windows or Linux you probably want to have a look at Zeal which is quite similar to Dash.

Installation for Dash

Download the latest revision of the docset and unzip it. To install it just double-click on Pony.docset and Dash will add it automatically.

Installation for Zeal (Linux or Windows)

Untested, taken from https://github.com/obstschale/octave-docset

To manually install a docset in Zeal, download the latest revision, unzip it and copy it into %HOMEPATH%\AppData\zeal\docset\. Restart Zeal and the documentation should be loaded automatically.

Generate docset

The docset is generated with an ugly combination of javascript and the original Pony documentation.

To generate the docset, simply run make. (Note: It will take a while).