obsidian-plugin/tmfelwu_obsidian-inbox
1
0
Fork 0
mirror of https://github.com/tmfelwu/obsidian-inbox.git synced 2026-07-22 07:40:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Naman Nanda 2023-04-11 13:14:03 +05:30 committed by GitHub
parent cb93c37c47
commit 55ab558a63
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -1,32 +1,4 @@
To create a global shortcut for the Obsidian plugin that can be used from anywhere in the operating system, you'll need to use an external tool to set up a system-wide hotkey. This hotkey will then be used to trigger a custom URL that opens Obsidian and runs the plugin command. Here's how to do it for different operating systems:
1. **Create a custom URL scheme for the plugin command:**
First, you need to create a custom URL that will open Obsidian and execute the plugin command. This URL will be used by the external tool to trigger the plugin. Update the `onload` method in the `main.ts` file of your plugin to register a URL handler:
```typescript
async onload() {
this.registerObsidianProtocolHandler('quick-capture', async (params) => {
const targetNoteTitle = 'Inbox'; // You can change this to any note title you prefer
const targetNote = this.app.vault.getAbstractFileByPath(`${targetNoteTitle}.md`);
const capturedText = await this.promptForText();
if (capturedText) {
await this.appendTextToNote(targetNote, capturedText);
}
});
// ... rest of the onload method
}
```
Now you can use the custom URL `obsidian://quick-capture` to trigger the plugin command.
2. **Set up a global hotkey using an external tool:**
**Set up a global hotkey using an external tool:**
**For Windows:**
@ -73,4 +45,4 @@ On Ubuntu 22.04, you can set up a global hotkey to trigger the Obsidian plugin c
7. Click on the "Disabled" text next to the new shortcut in the list. Press the desired key combination for the hotkey (e.g., Ctrl + Alt + C).
8. Close the settings application.
Now the global hotkey should be active and trigger the plugin command from anywhere in your operating system.
Now the global hotkey should be active and trigger the plugin command from anywhere in your operating system.