https://github.com/joethei/obsidian-key-promoter

Learn keyboard shortcuts by showing them when using the mouse
https://github.com/joethei/obsidian-key-promoter

obsidian obsidian-md obsidian-plugin

Last synced: 2 months ago
JSON representation

Learn keyboard shortcuts by showing them when using the mouse

• Host: GitHub
• URL: https://github.com/joethei/obsidian-key-promoter
• Owner: joethei
• License: mit
• Created: 2021-10-09T17:07:58.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-07-14T20:46:42.000Z (over 1 year ago)
• Last Synced: 2024-10-02T09:57:50.498Z (3 months ago)
• Topics: obsidian, obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 40 KB
• Stars: 37
• Watchers: 3
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Key Promoter

![GitHub package.json version](https://img.shields.io/github/package-json/v/joethei/obsidian-key-promoter)

![GitHub manifest.json dynamic (path)](https://img.shields.io/github/manifest-json/minAppVersion/joethei/obsidian-key-promoter?label=lowest%20supported%20app%20version)

![GitHub](https://img.shields.io/github/license/joethei/obsidian-key-promoter)

[![libera manifesto](https://img.shields.io/badge/libera-manifesto-lightgrey.svg)](https://liberamanifesto.com)

Plugin for [Obsidian](https://obsidian.md/)

---

## Key Promotion

![showcase](https://i.joethei.space/syvxdr4Wd1.gif)

When you use the mouse on a button this plugin will show a notification with the assigned shortcut for that action.

For buttons that don't have shortcuts assigned the plugin

will show you the name of the command to assign in the settings.

> ⚠ **Buttons are not directly associated with commands in Obsidian.**

> 

> Sometimes even the name of a button does not match the name of the command

> that executes the same action.

> 

> As a result you might get multiple different notifications when pressing one button.

## Description of Actions

![description of actions gif showcase](https://i.joethei.space/Obsidian_TPtxvJKucj.gif)

Shows a notification when pressing a hotkey with the called command and its

associated hotkey.

Useful for presentations.

Needs to be enabled in the settings.

## Statistics

Shows your most used commands.

![Statistics demo screenshot](https://i.joethei.space/Obsidian_TTidZwt2QH.png)

You can open this menu with the `Key Promoter: Statistics` Command.

---

Inspired by the [Key Promoter X](https://plugins.jetbrains.com/plugin/9792-key-promoter-x) and [Presentation Assistant](https://plugins.jetbrains.com/plugin/7345-presentation-assistant) plugins for [IntelliJ IDEA](https://jetbrains.com/idea).