mirror of
https://github.com/dragonwocky/obsidian-tray.git
synced 2025-04-15 16:49:02 +00:00
Compare commits
No commits in common. "main" and "0.1.1" have entirely different histories.
40
README.md
40
README.md
@ -1,39 +1,21 @@
|
||||
<img alt="" src="tray.png" align="right" height="128px">
|
||||
|
||||
**Tray** is an [Obsidian](https://obsidian.md/) plugin that can be used to launch the app
|
||||
on system startup and run it in the background, adding global hotkeys and a tray menu to
|
||||
toggle window visibility and create quick notes from anywhere in your operating system.
|
||||
on system startup and run it in the background, adding an icon to the system tray that it
|
||||
can be minimised to and a global hotkey to toggle visibility of the app's windows.
|
||||
|
||||
## Configuration
|
||||
|
||||
### Window management
|
||||
|
||||
| Option | Description | Default |
|
||||
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
|
||||
| Launch on startup | Open Obsidian automatically whenever you log into your computer. | Disabled |
|
||||
| Hide on launch | Minimises Obsidian automatically whenever the app is launched. If the "Run in background" option is enabled, windows will be hidden to the system tray/menubar instead of minimised to the taskbar/dock. | Disabled |
|
||||
| Run in background | Hide the app and continue to run it in the background instead of quitting it when pressing the window close button or toggle focus hotkey. | Disabled |
|
||||
| Hide taskbar icon | Hides the window's icon from from the dock/taskbar. This may not work on Linux-based OSes. | Disabled |
|
||||
| Create tray icon | Add an icon to your system tray/menubar to bring hidden Obsidian windows back into focus on click or force a full quit/relaunch of the app through the right-click menu. | Enabled |
|
||||
| Tray icon image | Set the image used by the tray/menubar icon. Recommended size: 16x16 |  |
|
||||
| Tray icon tooltip | Set a title to identify the tray/menubar icon by. The `{{vault}}` placeholder will be replaced by the vault name. | `{{vault}} \| Obsidian` |
|
||||
| Toggle window focus hotkey | This hotkey is registered globally and will be detected even if Obsidian does not have keyboard focus. Format: [Electron accelerator](https://www.electronjs.org/docs/latest/api/accelerator) | <kbd>CmdOrCtrl+Shift+Tab</kbd> |
|
||||
|
||||
The `Relaunch Obsidian` and `Close Vault` actions can be triggered from the tray/menubar context menu,
|
||||
or with the in-app command palette (search for "Tray: Relaunch Obsidian" or "Tray: Close Vault").
|
||||
Hotkeys can be assigned to the commands via Obsidian's built-in hotkey manager.
|
||||
|
||||
### Quick notes
|
||||
|
||||
| Option | Description | Default |
|
||||
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
|
||||
| Quick note location | New quick notes will be placed in this folder. | |
|
||||
| Quick note date format | New quick notes will use a filename of this pattern. Format: [Moment.js format string](https://momentjs.com/docs/#/displaying/format/) | `YYYY-MM-DD` |
|
||||
| Quick note hotkey | This hotkey is registered globally and will be detected even if Obsidian does not have keyboard focus. Format: [Electron accelerator](https://www.electronjs.org/docs/latest/api/accelerator) | <kbd>CmdOrCtrl+Shift+Q</kbd> |
|
||||
| Option | Description | Default |
|
||||
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
|
||||
| Launch on startup | Open Obsidian automatically whenever you log into your computer. | Enabled |
|
||||
| Run in background | Hide the app and continue to run it in the background instead of quitting it when pressing the window close button or toggle focus hotkey. If both this and "Launch on startup" are enabled, windows will be hidden automatically whenever the app is initialised. | Disabled (Otherwise the window would disappear as soon as the plugin is installed and enabled.) |
|
||||
| Create tray icon | Add an icon to your system tray/menubar to bring hidden Obsidian windows back into focus on click or force a full quit/relaunch of the app through the right-click menu. _Changing this option requires a restart to take effect._ | Enabled |
|
||||
| Toggle window focus hotkey | Format: [Electron accelerator](https://www.electronjs.org/docs/latest/api/accelerator) | CmdOrCtrl+Shift+Tab |
|
||||
|
||||
## Installation
|
||||
|
||||
### Obsidian Marketplace
|
||||
### Obsidian Marketplace (Coming Soon)
|
||||
|
||||
1. In Obsidian, navigate to **Settings** → **Community plugins**.
|
||||
2. Press the **Browse** button beside the **Community plugins** option.
|
||||
@ -61,7 +43,3 @@ This plugin is provided as-is and is designed for personal use. It has not
|
||||
been tested on every platform and may not work as expected with all future updates.
|
||||
If you notice something is not working as intended, please open a bug report or
|
||||
pull request so it can be fixed.
|
||||
|
||||
The Obsidian logo is distributed with this plugin as the default image for the system
|
||||
tray/menubar icon, intended to be used within Obsidian. This logo remains the property
|
||||
of the Obsidian project and is not under the same license as the plugin's source code.
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
{
|
||||
"id": "tray",
|
||||
"id": "obsidian-tray",
|
||||
"name": "Tray",
|
||||
"author": "dragonwocky",
|
||||
"authorUrl": "https://dragonwocky.me/",
|
||||
"description": "Run Obsidian from the system tray for customisable window management & global quick notes",
|
||||
"version": "0.3.5",
|
||||
"description": "Launch Obsidian on startup and run it in the background from the system tray.",
|
||||
"version": "0.1.1",
|
||||
"isDesktopOnly": true,
|
||||
"minAppVersion": "1.0.0"
|
||||
}
|
||||
|
||||
BIN
obsidian.png
BIN
obsidian.png
Binary file not shown.
|
Before Width: | Height: | Size: 580 B |
Loading…
Reference in New Issue
Block a user