ryanamay/inkdrop-command-palette
1
0
Fork 0
mirror of https://github.com/ryanamay/inkdrop-command-palette.git synced 2024-09-20 01:40:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix readme

Browse source
This commit is contained in:
fuwaa 2022-08-24 17:09:10 +08:00
parent 131f44738a
commit ce451c1024
No known key found for this signature in database
GPG key ID: 7CE0BF0D3175E2DC
1 changed files with 15 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,9 +1,11 @@
# inkdrop command palette # inkdrop command palette
A VSCode-like command palette for Inkdrop. A VSCode-like command palette for Inkdrop.
![Inkdrop_logbdEi1qT](https://user-images.githubusercontent.com/53419401/186372300-eadccb9e-5acb-4771-ac1c-1d46728ce75a.gif) ![Inkdrop_logbdEi1qT](https://user-images.githubusercontent.com/53419401/186372300-eadccb9e-5acb-4771-ac1c-1d46728ce75a.gif)
## Features ## Features
- Access and Invoke almost any command in Inkdrop. - Access and Invoke almost any command in Inkdrop.
- Filter commands by `.` for Formatting Commands and by `>` for application commands. - Filter commands by `.` for Formatting Commands and by `>` for application commands.
- Know which keyboard shortcuts are associated per command[^1]. - Know which keyboard shortcuts are associated per command[^1].
@ -11,30 +13,36 @@ A VSCode-like command palette for Inkdrop.
- Extensible and easily configurable for plugin developers. - Extensible and easily configurable for plugin developers.
## Install ## Install
```css ```css
ipm install command-palette ipm install command-palette
``` ```
## Keybindings ## Keybindings
| Command | Explanation | Keybind |
|--|--|--| | Command | Explanation | Keybind |
|commandpalette:toggle| Shows/Hides the Command Palette | Ctrl+K | --------------------- | ------------------------------- | ------- |
| commandpalette:toggle | Shows/Hides the Command Palette | Ctrl+K |
#### add it to your keymap.cson #### add it to your keymap.cson
```js ```js
'body': 'body':
'ctrl-k': 'commandpalette:toggle' 'ctrl-k': 'commandpalette:toggle'
``` ```
## Changelog
### Changelog
#### 1.0.0 - 08/24/2022 #### 1.0.0 - 08/24/2022
- Initial release, yay! - Initial release, yay!
### Ideas ## Ideas
- [ ] configurable settings? I don't know what to put here though... - [ ] configurable settings? I don't know what to put here though...
### Todo ## Todo
- [ ] ability to use commands that require an argument, **requires a bit of reverse engineering** - [ ] ability to use commands that require an argument, **requires a bit of reverse engineering**
- [ ] finalize decision on whether i should isolate commands such as `focus on ****` because we'd be already focusing on it or have another command invokable related to it that works targeted by the selector[^3]. - [ ] finalize decision on whether i should isolate commands such as `focus on ****` because we'd be already focusing on it or have another command invokable related to it that works targeted by the selector[^3].
- [ ] code documentation/prettify to make it less stressful on the eyes. - [ ] code documentation/prettify to make it less stressful on the eyes.
@ -43,4 +51,3 @@ ipm install command-palette
[^1]: Current version is limited to only default keybindings, planned support for user defined `keymaps.cson` is in the works. [^1]: Current version is limited to only default keybindings, planned support for user defined `keymaps.cson` is in the works.
[^2]: Provided that the plugin developer provides support for their command via `lib/commands/plugins.js` [^2]: Provided that the plugin developer provides support for their command via `lib/commands/plugins.js`
[^3]: For now, if you search for a command like that, it won't show anything but it's always visible on the full list, oh and you can't invoke it either. [^3]: For now, if you search for a command like that, it won't show anything but it's always visible on the full list, oh and you can't invoke it either.