Refi is an open source API Documentation Browser for Linux, which makes use of DocSets
(with permission) originally used in the Dash application for OSX.
refi-demo.webm
This project is still very much a WIP, however you can install DocSets, search for and view results.
- auto update docsets at startup
- auto update docsets on a schedule
- global hotkey activation
- per docset favorites
- flesh out settings page
- others?
- Go v1.18+
- NodeJS v20+
- Yarn v1.x
This application uses wails, which is a Go based web application container similar but allot lighter than Electron.
go install github.com/wailsapp/wails/v2/cmd/wails@latestSee here for more detailed installation instructions.
To run in live development mode, run wails dev -tags webkit2_42.
If you want to develop in a browser and have access to your Go methods, there is also a dev server that runs on http://localhost:34115. Connect to this in your browser, and you can call your Go code from devtools.
To build a redistributable, production mode package, run wails build.
If you find a bug please log an issue, decribing in as much detail as possible including your OS.
To avoid your hard work not being merged, please discuss any changes or fixes with me first. Once we agree on a solution, fork the repo and create a pull request, making sure to link any related issue.
Distributed under the GPL-3.0 License. See LICENSE for more information.