mTvare6 / htBrowser

A hotkey browser made for developers to have easy doc access on any screen

htBrowser

A browser made for developers to search through documentation while staying in editor.

Keybind to pull up the window:

⌘+Shift+~
or
Ctrl+Shift+~

Configuration:

htBrowser looks for config under

• $XDG_CONFIG_HOME/htBrowser/config.json on linux
• $HOME/.config/htBrowser/config.json on macOS
• %%APPDATA%%/htBrowser/config.json on windows

The following is a example config

{
  "window": {
    "width": 640,
    "height": 400
  },
  "defaultURL": "https://duckduckgo.com",
  "keyBind":"CmdOrCtrl+Shift+~",
  "customURLS": [
    {
      "discord": "https://discord.com/developers/docs/intro"
    }
  ]
}

window part should be self-explantory
keyBind is the keybind which pulls up the window, the string must be a valid accelator
defaultURL is the url the browser switches by default which are overriden if customURL matches
customURLS is a set of WM_CLASS and url paired, where the browser is launched if the current WM_CLASS value is one of those, the value of url is what the browser switches to.

Building

To setup

npm install

To run

npm start

To build install electron-packager or download from github workflows

Caveats:

Currently in order to work under TWM's you need to set a rule so hTbrowser isn't resized or moved, I am trying to find workarounds