https://github.com/semanticdata/obsidian-essential-shortcuts
This plugin provides essential keyboard shortcuts for Obsidian to enhance its functionality.
https://github.com/semanticdata/obsidian-essential-shortcuts
obsidian obsidian-plugin
Last synced: 25 days ago
JSON representation
This plugin provides essential keyboard shortcuts for Obsidian to enhance its functionality.
- Host: GitHub
- URL: https://github.com/semanticdata/obsidian-essential-shortcuts
- Owner: semanticdata
- Created: 2025-01-24T21:04:06.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-24T22:24:17.000Z (over 1 year ago)
- Last Synced: 2025-01-24T22:24:55.055Z (over 1 year ago)
- Topics: obsidian, obsidian-plugin
- Language: TypeScript
- Homepage:
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ⌨️ Essential Shortcuts
Provides essential keyboard shortcuts for Obsidian to enhance its functionality.
## ✨ Features
| Feature Description | Keyboard Shortcut |
| ------------------------------------------------------- | ---------------------- |
| Select the current line and expand selection | `Ctrl + L` |
| Select the current word or expand selection | `Ctrl + D` |
| Select all occurrences of the current selection or word | `Ctrl + Shift + L` |
| Duplicate the current line(s) downward | `Alt + Shift + Down` |
| Duplicate the current line(s) upward | `Alt + Shift + Up` |
| Insert a cursor above the current line | `Ctrl + Alt + Up` |
| Insert a cursor below the current line | `Ctrl + Alt + Down` |
| Insert a line above the current line | `Ctrl + Shift + Enter` |
| Insert a line below the current line | `Ctrl + Enter` |
| Sort selected lines in alphabetical order | `Not Set` |
| Sort selected lines in reverse alphabetical order | `Not Set` |
| Transform selection to uppercase | `Not Set` |
| Transform selection to lowercase | `Not Set` |
| Transform selection to title case | `Not Set` |
| Toggle case of the selection | `Not Set` |
| Jump to next heading | `Alt + PageDown` |
| Jump to previous heading | `Alt + PageUp` |
## 💡 Ideas for Future Development
- Copy line (without selection)
- Delete line (without selection)
- Insert current date/time (configurable format)
- Add cursors when using `Ctrl + D` to each word
## 📦 Installation (_NOT AVAILABLE IN THE COMMUNITY PLUGINS YET!_)
1. Open Obsidian Settings
2. Navigate to Community Plugins (_NOT AVAILABLE YET!_) and disable Safe Mode
3. Click Browse and search for "Essential Shortcuts"
4. Install the plugin
5. Enable the plugin in your Community Plugins list
### 🏗️ Building
1. Clone this repository
2. Run `npm install`
3. Run `npm run dev` to start compilation in watch mode
4. Run `npm run build` to build the plugin
5. Run `npm run lint` to check for linting errors
6. Run `npm run lint` to lint for errors
### 📁 Manual Installation
1. Create a new folder `essential-shortcuts` in your vault's `.obsidian/plugins` folder
2. Copy `main.js`, `manifest.json`, and `styles.css` to the new folder
3. Reload Obsidian to load the plugin
## Releasing new releases
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example:
- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
- Publish the release.
> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
## Adding your plugin to the community plugin list
- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
- Publish an initial version.
- Make sure you have a `README.md` file in the root of your repo.
- Make a pull request at to add your plugin.
## API Documentation
See
## 📜 License
The code in this repository is available under the [MIT License](LICENSE).