Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrisgrieser/obsidian-smarter-md-hotkeys
A plugin for Obsidian providing hotkeys that select words and lines in a smart way before applying markup. Multiple cursors are supported as well.
https://github.com/chrisgrieser/obsidian-smarter-md-hotkeys
markdown obsidian-plugin
Last synced: 18 days ago
JSON representation
A plugin for Obsidian providing hotkeys that select words and lines in a smart way before applying markup. Multiple cursors are supported as well.
- Host: GitHub
- URL: https://github.com/chrisgrieser/obsidian-smarter-md-hotkeys
- Owner: chrisgrieser
- License: mit
- Created: 2021-11-19T10:21:48.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-03T14:28:57.000Z (7 months ago)
- Last Synced: 2024-10-15T07:32:26.378Z (29 days ago)
- Topics: markdown, obsidian-plugin
- Language: TypeScript
- Homepage:
- Size: 23.2 MB
- Stars: 132
- Watchers: 3
- Forks: 8
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - chrisgrieser/obsidian-smarter-md-hotkeys - A plugin for Obsidian providing hotkeys that select words and lines in a smart way before applying markup. Multiple cursors are supported as well. (TypeScript)
README
# Archival Notice
Most of the plugin's features are part of Obsidian Core by now. Therefore, the plugin is archived. Thank you everyone for a total of 20 000 Downloads!
---
# 🧠 Smarter Markdown Hotkeys
  [](Changelog.md)
A plugin for [Obsidian](https://obsidian.md/) providing hotkeys that select words and lines in a smart way[^4] before applying markup. Multiple cursors are supported as well.
## Table of Contents
- [Markup Commands with Smart Expansion](#markup-commands-with-smart-expansion)
- [Command-Specific Details](#command-specific-details)
- [Non-Markup Commands with Smart Expansion Logic](#non-markup-commands-with-smart-expansion-logic)
- [Smarter Punctuation Commands](#smarter-punctuation-commands)
- [Smarter Case Switching](#smarter-case-switching)
- [Smarter Delete Text](#smarter-delete-text)
- [Commands without Smart Expansion](#commands-without-smart-expansion)
- [Smarter Toggle Heading](#smarter-toggle-heading)
- [Smarter Insert New Line](#smarter-insert-new-line)
- [Smarter Delete Current Note](#smarter-delete-current-note)
- [Smarter Copy Path](#smarter-copy-path)
- [Smarter Copy File Name](#smarter-copy-file-name)
- [Toggle Readable Line Length & Toggle Line Numbers](#toggle-readable-line-length--toggle-line-numbers)
- [How the Smart Expansion works in detail](#how-the-smart-expansion-works-in-detail)
- [Setting the Hotkeys](#setting-the-hotkeys)
- [Installation](#installation)
- [Contribute](#contribute)
- [About the Developer](#about-the-developer)
- [Profiles](#profiles)
- [Donate](#donate)
- [Credits](#credits)
## Markup Commands with Smart Expansion
- Smarter Bold
- Smarter Italics
- Smarter Underscore Bold (`__foobar__`)
- Smarter Underscore Italics (`_foobar_`)
- Smarter Comment\*
- Smarter HTML Comment\*
- Smarter Inline/Fenced Code\*
- Smarter Highlight
- Smarter Bold & Highlight[^3]
- Smarter Italics & Highlight[^3]
- Smarter Strikethrough
- Smarter Markdown/Image Link
- Smarter Wikilink (Internal Link)
- Smarter Wikilink with Heading
- Smarter Mathjax\*
- Smarter Callout Label
All commands also support __multiple cursors__, smart __inclusion/exclusion of special characters__, and __undoing markup__ by triggering the same hotkey.
\* These commands _wrap whole blocks_ instead of wrapping each line when the hotkey is triggered on a multi-line selection. They also switch to the appropriate syntax, for example from inline code syntax to fenced code syntax. (See below for details.)
### Command-Specific Details
The following commands have some special features:
#### Smarter Markdown/Image Link
- __Auto-Insert URLs__: When you use `Smarter Markdown Link` and have an URL in your clipboard, the URL will automatically get inserted as well.
- __Automatic Switch to Image Syntax__ When the URL in the clipboard ends with an image extension like `.png`,[^2] the command will also prepend the `!` for image links.
#### Smarter Inline/Fenced Code
- __Terms instead of Words:__ `Smarter Code` will _not_ consider punctuation or brackets as delimiters. This means that a cursor anywhere in "object.method" will select the whole term and result correctly in "`object.method`" instead of "`object`.method". (Similar to WORD in Vim.)
- __Automatic Switch to Fenced Code Syntax__: When more than one line is selected, `Smarter Code` will wrap the selected lines in [fenced code syntax](https://help.obsidian.md/How+to/Format+your+notes#Code+blocks) instead. Furthermore, the cursor is moved to the beginning of the fenced code block so you can conveniently enter the code language.
- 💡 `Smarter Fenced Code` synergizes well with the [Codeblock Completer Plugin](https://github.com/SkepticMystic/codeblock-completer).
#### Smarter Comment
- __Automatic Switch to Block Comments__: When more than one line is selected, the `Smarter Comment` commands will expand the selection to whole blocks and then [wrap all of them together](https://help.obsidian.md/How+to/Format+your+notes#Comments) into the comment syntax.
#### Smarter Wikilink
- __Auto-Suggest__: When turning text into a wikilink, `Smarter Wikilinks` will trigger the suggester afterwards.
- __Wikilink a Heading__: Alternative command that inserts the syntax for a markdown link to a heading, and also triggers the Suggester after doing so. (i.e., instead of `[[ ]]`, it uses `[[## ]]`).
#### Smarter Mathjax
- __Automatic Switch to Blocks__: When more than one line is selected, the `Smarter MathJax` command will also [expand the selection to whole blocks](https://help.obsidian.md/How+to/Format+your+notes#Math) and switch from `$` to `$$`. (I do not use Mathjax myself, so feel free to open an issue when the Mathjax command can be improved somehow.)
#### Smarter Callout Label
Turns the text under the cursor into a callout _label_.
Demo
## Non-Markup Commands with Smart Expansion Logic
### Smarter Punctuation Commands
While strictly speaking quotation marks and brackets are not a form of markup, I found it quite useful to be able to set them in the same way. Therefore, the following commands have been added as well.
- Smarter Quotation Marks
- Smarter Round Brackets
- Smarter Square Brackets
- Smarter Curly Brackets
When there is no selection, the the Smarter Punctuation Commands essentially emulate `ysiw"`, `ysiw)`, `ysiw]`, and `ysiw}` from [vim-surround](https://github.com/tpope/vim-surround).
### Smarter Case Switching
The same logic can also be applied to case switching commands. First, the selection is expanded to whole words. Then, the casing of the whole selection is changed. Instead of having multiple hotkeys for each type of casing, this command smartly switches the case depending on the current state.
- `lower case` → `Sentence case`\*
- `Sentence case`\* → `UPPER CASE`
- `UPPER CASE` → `lower case`
- `OTheR` → `Sentence case`
This allows you to repeatedly press the hotkey to achieve a certain result, e.g. two times on a `lowercase` word to make it `UPPERCASE`.
\* `Sentence case` means that the first letter of the string will be capitalized, like in an English sentence. If the string only contains one word, `Sentence case` produces the same result as `Capital Case`.
### Smarter Delete Text
Deletes text with the same text-expanding logic from the smarter markdown commands. (This command is similar to `daw` in Vim.)
## Commands without Smart Expansion
These commands have simply been added for convenience. They do not use any kind of selection expansion, but are still attempts to improve the normal commands they correspond to.
### Smarter Toggle Heading
Increases the Heading Level of the line under the cursor by 1. If already at 6, removes the heading instead. Intended for pressing it quickly multiple times, e.g. pressing the hotkey 3 times to turn a normal line into a h3.
### Smarter Insert New Line
Inserts line break, even when the cursor is in a nested list. Pressing `return` in a nested list normally inserts a line break followed by a indented list marker. (This command is essentially the same as `o` in Vim.)
### Smarter Delete Current Note (deprecated)
Deletes the current note, but also goes back to the last file instead of leaving an empty pane. (This requires `Confirm File Deletion` in the Obsidian settings to be _disabled_.)
*Deprecated. With recent versions of Obsidian, deleting a file does not result in empty panes, so this command is now basically obsolete. The command is only left in the plugin to ensure people's hotkeys do not break.*
### Smarter Copy Path
Press once to copy the vault-relative path of the current file, press a second time to copy the absolute path. Press a third time to copy the (vault-relative) path to the parent folder.
### Smarter Copy File Name
Press once to copy the name of the current file without extension, press a second time to copy it with extension.
### Toggle Readable Line Length & Toggle Line Numbers
These do pretty much what the name says.
## How the Smart Expansion works in detail
`Inline code` signifies the part of the text being selected. `|` is a cursor without selection. This table serves as a reference for the precise mechanics of this plugin.
| | Normal Hotkeys | Smarter Hotkeys |
| ---------------------------------- | ------------------------------------------------------ | ------------------------------------------------------------------ |
| foo`\|`bar | foo\*\*\*\*bar | \*\*__foobar__\*\* |
| f`oo`bar | f\*\*__oo__\*\*bar | \*\*__foobar__\*\* |
| Lor`em Ips`um | Lor\*\*__em Ips__\*\*um | \*\*__Lorem Ipsum__\*\* |
| `- [ ] foobar ^123` | \*\*__- [ ] foobar ^123__\*\* | - [ ] \*\*__foobar__\*\* ^123 |
| `## Lorem Ipsum` | ==__## Lorem Ipsum__== | ## ==__Lorem Ipsum__== |
| - Lor`em`
`- Ips`um | - Lor\*\***em
- Ips**\*\*um | - \*\*__Lorem__\*\*
- \*\*__Ipsum__\*\* |
| \*\*__foo__`\|`__bar__\*\* _(Undo)_| \*\***foo\*\*\*\*bar**\*\* | foobar |
| \*\***Lor`em Ips`um**\*\* _(Undo)_ | \*\*__Lor__\*\*em Ips\*\*__um__\*\* | Lorem Ipsum |
You can take a look which characters exactly are included or excluded by taking a look at the [`const.ts`](const.ts#L144).
## Setting the Hotkeys
If you want to replace the default commands from Obsidian, remember to remove their hotkey binding before changing the hotkeys from this plugin. Example for `Smarter Bold`:
1. Remove the hotkey `cmd/ctrl + B`[^1] for the default command `Toggle Bold`.
2. Assign `cmd/ctrl + B` as the hotkey for the command `Smarter Bold`.
💡 For the Smarter Punctuation Commands, you can also use a hotkey with `shift`, e.g. `shift + 2` for Smarter Quotation Marks. Curiously, Obsidian accepts such hotkeys, so you can basically "overwrite" normal punctuation typing if you want to.
However, note that this comes at the cost of losing the ability to type punctuation normally. Also, this does seem to result in minor bugs, e.g. [interference with Obsidian's in-document search](https://github.com/chrisgrieser/obsidian-smarter-md-hotkeys/issues/23).
## Installation
The plugin is available in Obsidian's Community Plugin Browser via: `Settings` → `Community Plugins` → `Browse` → Search for _"Smarter Markdown Hotkeys"_
## Contribute
The easiest way to make contributions is to make changes to `const.st`, since the constants there determine commands and what to include/exclude.
Please use the `.eslintrc` configuration located in the repository and run eslint before doing a pull request, and do _not_ use `prettier`. 🙂
```shell
# Run eslint fixing most common mistakes
eslint --fix *.ts
```
## About the Developer
In my day job, I am a sociologist studying the social mechanisms underlying the digital economy. For my PhD project, I investigate the governance of the app economy and how software ecosystems manage the tension between innovation and compatibility. If you are interested in this subject, feel free to get in touch!
### Profiles
- [Academic Website](https://chris-grieser.de/)
- [ResearchGate](https://www.researchgate.net/profile/Christopher-Grieser)
- [Discord](https://discordapp.com/users/462774483044794368/)
- [GitHub](https://github.com/chrisgrieser/)
- [Twitter](https://twitter.com/pseudo_meta)
- [LinkedIn](https://www.linkedin.com/in/christopher-grieser-ba693b17a/)
### Donate
If you feel very generous, you may also buy me something from my Amazon wish list. But please donate something to developers who still go to college, before you consider buying me an item from my wish list! 😊
[Amazon wish list](https://www.amazon.de/hz/wishlist/ls/2C7RIOJPN3K5F?ref_=wl_share)
## Credits
Thanks to [@SkepticMystic](https://github.com/SkepticMystic) for his support during development.
[⬆️ Go Back to Top](#table-of-contents)
[^1]: macOS uses `cmd`, Windows and Linux use `ctrl`.
[^2]: The supported image extensions are [listed here](const.ts#L156).
[^3]: These commands are mostly used for Multi-Color Highlights that some Obsidian themes like [Sanctum](https://github.com/jdanielmourao/obsidian-sanctum) or [Shimmering Focus](https://github.com/chrisgrieser/shimmering-focus) offer.
[^4]: When there is no selection, the smart expansion is essentially equivalent to `ysiw{markup}` from [vim-surround](https://github.com/tpope/vim-surround), but with less keystrokes.