Skip to content
This repository has been archived by the owner on Jan 8, 2022. It is now read-only.

egoist/devdocs-desktop

Repository files navigation

DevDocs Desktop

日本語説明ページはこちら

version downloads downloads latest

DevDocs.io combines multiple API documentations in a fast, organized, and searchable interface. This is an unofficial desktop app for it.

devdocs-preview

Features

Background behavior

When closing the window, the app will continue running in the background, in the dock on macOS and the tray on Linux/Windows. Right-click the dock/tray icon and choose Quit to completely quit the app. On macOS, click the dock icon to show the window. On Linux, right-click the tray icon and choose Toggle to toggle the window. On Windows, click the tray icon to toggle the window.

Build-in shortcuts

devdocs the website itself has great built-in shortcuts support, just check the help page in the app.

help

Planned features

Please consider sponsoring me to accelerate development.

  • Menubar mode: switch beween desktop mode and menubar mode
  • Tabs support: allow to open documentation in a new tab

Global shortcut

Use Ctrl+Shift+D (or Command+Shift+D on macOS) to toggle the app.

Install

Using Homebrew

brew install --cask devdocs

Manual download

You can manually download the latest release here.

Development

It's really easy to develop this app, no build tools like Webpack needed here, checkout ./app to get more:

npm install

npm run app
# edit files, save, refresh and it's done.

Distribute

npm run dist

License

MIT © EGOIST