Skip to content

Commit

Permalink
One more README tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
andyzito committed Jan 18, 2024
1 parent e49d13b commit 19eb45a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Nice KBDs

This Obsidian plugin automatically detects keyboard shortcuts and wraps them in <kbd> tags. For example, ⌘ + A becomes <kbd>⌘</kbd> + <kbd>A</kbd>, making keyboard combinations clear and visually distinct (styles included).
This Obsidian plugin automatically detects keyboard shortcuts and wraps them in `<kbd>` tags, indicating a 'keyboard input'. For example, `⌘ + A` becomes <kbd>⌘</kbd> + <kbd>A</kbd>, making keyboard combinations clear and visually distinct (styles included).

Additionally, this plugin introduces a unique Markdown syntax for manually specifying keyboard inputs. Using configurable wrapper characters, you can indicate key combos, like `«CMD»` <kbd>CMD</kbd>.
Additionally, this plugin introduces a unique Markdown syntax for manually specifying keyboard inputs: `«CMD»` will become <kbd>CMD</kbd>.

![Examples of key combos](demo.png)

Expand Down

0 comments on commit 19eb45a

Please sign in to comment.