jmerle/deskdocs

A feature-rich desktop application for DevDocs.io

DeskDocs

DeskDocs is a feature-rich desktop application for DevDocs.io which wraps 150+ API documentations in a fast, consistent and searchable interface.

DeskDocs is a work-in-progress at the moment. Not all features listed below are implemented yet and the download links don't work yet. PR's are not accepted at this time.

Highlights

• Dark mode
• Tabs
• In-page search
• Global shortcut
• Auto restore
• Launch on boot
• Toggleable menu bar
• Cross-platform

Install

macOS 10.10+, Linux, and Windows 7+ are supported (64-bit only).

macOS

Download the .dmg file.

The application is unsigned. The first time you run the application you'll need to manually go to the /Applications folder, right click on DeskDocs and click "Open". This pops up an alert asking you whether you want to run the application, which you need to confirm.

Linux

Download the .AppImage or .deb file.

Also available as a snap.

The AppImage needs to be made executable after download.

Windows

Download the .exe file.

The application is unsigned. If SmartScreen pops up, click on "More Info" and click on the "Run Anyways" button.

Features

Most features are configurable in the preferences, which can be opened using Ctrl+, on Linux and Windows and ⌘+, on macOS.

Dark mode

TBD

Tabs

TBD

In-page search

TBD

Global shortcut

TBD

Auto restore

TBD

Launch on boot

TBD

Toggleable menu bar

TBD

Development

DeskDocs is built with Electron and TypeScript. Yarn is used for dependency management. After installing the dependencies with yarn, the following commands can be useful:

# Start the application with hot-reloading enabled on the main process
$ yarn start

# Package the application for the current platform
$ yarn package

# Lint the code
$ yarn lint

# Auto-fix linting issues
$ yarn fix

Releases

Running yarn release starts an interactive UI to publish a new version. After the command finishes and a browser window opens to create a new draft, save it immediately to allow the Travis build to attach assets to it. After the Travis build is finished the draft can be released. To release to the Snap store, run yarn publish-snap on a machine with snapcraft installed and configured.