Skip to content

Obsidian plugin to display command hotkeys on a visible keyboard layout

License

Notifications You must be signed in to change notification settings

cogscides/obsidian-keyboard-analyzer

Repository files navigation

Keyboard Analyzer

ko-fi


image

📽️ Features walktrough video
Walkthrough.mp4

About

With this plugin you will be able to:

  • see and analyze all your assigned hotkeys in Obsidian on visual keyboard layout
  • search by key combination
  • see custom hotkeys
  • see duplicate hotkeys
  • highlight featured hotkeys

How to use

  1. To open plugin you can click on keyboard icon in status bar (to open in a new pane use Ctrl + Click)
  2. To open plugin run command Keyboard Analyzer: Open Shortcuts View

The plugin is poorly tested on operating systems other than Windows, I would be grateful for any help with testing support.

Installation

As plugin is not yet published in community plugins library, you will need to install it manually or with help of BRAT plugin for beta testing.

Manual Installation

Download release files main.js, styles.css and manifest.json from the releases and place this files inside [YOUR_OBSIDIAN_FOLDER]/.obsidian/.plugins/obsidian-keyboard-analyzer/.

Beta Testing - BRAT

  1. Install BRAT plugin
  2. Run command in obsidian: Obsidian42 - BRATPlugins: add a beta plugin for testing
  3. Paste this repository URL: https://github.com/cogscides/obsidian-keyboard-analyzer
  4. Enable Keyboard Analyzer plugin in plugins list

P.S. This is my first public code in my life - would be happy to get feedback or a donation which will help me to continue creating this and other plugins for obsidian.


Great thanks to the obsidian community:

  • @SkepticMystic and @HEmile for their awesome contribution to Svelte codebase of Graph Analysis plugin which help me a lot in implementing typescript and code structure in my plugin
  • @pjeby for code inspiration dealing with obsidian hotkeys
  • @Fevol for help with implementing hotkey scoping and friendly support
  • davfive#5786 guy from discord for directing me on the way how to deal with obsidian hotkeys

About

Obsidian plugin to display command hotkeys on a visible keyboard layout

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published