https://github.com/william8th/javadocset
A port of Kapeli's (Dash and Zeal) javadocset in Golang
https://github.com/william8th/javadocset
dash dash-docset docset kapeli-dash zeal zeal-docset zealdocs
Last synced: 5 months ago
JSON representation
A port of Kapeli's (Dash and Zeal) javadocset in Golang
- Host: GitHub
- URL: https://github.com/william8th/javadocset
- Owner: william8th
- License: gpl-3.0
- Created: 2017-05-27T20:22:04.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-11-16T21:01:47.000Z (over 7 years ago)
- Last Synced: 2025-08-15T07:26:16.672Z (10 months ago)
- Topics: dash, dash-docset, docset, kapeli-dash, zeal, zeal-docset, zealdocs
- Language: Go
- Size: 2.55 MB
- Stars: 22
- Watchers: 2
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
javadocset
==========
This is a port of Kapeli's javadocset tool in Golang. I ported this tool as an exercise for me to use Golang and also to contribute to Zealdoc's users as most Dash users who use a Mac are able to run Kapeli's javadocset tool (which can be found [here](https://github.com/Kapeli/javadocset)).
# Build Instructions
## Prerequisites
You need to have Go 1.8.3 and above installed to be able to use this tool
## Instructions
It's as simple as:
```
go get github.com/william8th/javadocset
```
## Usage
```
javadocset
# where:
# = the name of the docset that will appear on Dash/Zeal
# = the folder containing the generated HTML Java doc
```
# Credits
Credits go to Kapeli: [https://github.com/Kapeli/javadocset](https://github.com/Kapeli/javadocset)
Zeal: [https://github.com/zealdocs/zeal](https://github.com/zealdocs/zeal)
Dash: [https://kapeli.com/dash](https://kapeli.com/dash)
## Note
There is no guarantee that this will work 100%. I've tried my best to verify against a Java doc that I own but there may be bugs that I've not had the chance to discover. Please open an issue if you're having any trouble!
Pull requests are welcome :)