Kakoune: added initial documentation

This commit is contained in:
2026-04-21 19:17:05 +02:00
parent 5aee1f540c
commit adbc56fb36
+9 -7
View File
@@ -43,6 +43,7 @@ Before building NoteWrapper, you must install the following dependencies:
You must also have a [supported editor (and their associated plugin if needed)](#editor-support) installed:
* `helix`
* `kakoune`
* `nano`
* `neovim`
* `vim`
@@ -140,12 +141,13 @@ The first two features depend on [Vivify's editor integration](https://github.co
If your editor does not support these features, you can implement a plugin using [Vivify's API](https://github.com/jannis-baum/Vivify?tab=readme-ov-file#editor-support).
| Editor | Bufferless | Cursor | Jump to end | Plugin required |
| ------ | ----------- | ------- | ------------ | --------------------------------------------------------|
| Helix | ❌ | ❌ | ✅ | — |
| Nano | ❌ | ❌ | ✅ | — |
| Neovim | | | ✅ | [vivify-vim](https://github.com/jannis-baum/vivify.vim) |
| Vim | ✅ | ✅ | ✅ | [vivify-vim](https://github.com/jannis-baum/vivify.vim) |
| Editor | Bufferless | Cursor | Jump to end | Plugin required |
| --------- | ----------- | ------- | ------------ | --------------------------------------------------------|
| Helix | ❌ | ❌ | ✅ | — |
| Kakoune | ❌ | ❌ | ✅ | — |
| Nano | | | ✅ | |
| Neovim | ✅ | ✅ | ✅ | [vivify-vim](https://github.com/jannis-baum/vivify.vim) |
| Vim | ✅ | ✅ | ✅ | [vivify-vim](https://github.com/jannis-baum/vivify.vim) |
[How to add support for another editor](./CONTRIBUTING.md#adding-editor-support)
@@ -202,5 +204,5 @@ It is recommended to use a browser different from your main one for rendering.
* [ ] A converter between journal types
* [ ] Support multiple vault directories
* [ ] Port NoteWrapper to other editors (non-exhaustive list of planned ports: `emacs -nw`, `micro`, `jed`, kakoune, `ad`, flow-control, `ee`, `amp`, `dte`, `cano`, `mle`, `zee`, `ptext`, `kibi`, `ox`, `ne`, `nvi`, `dit`, `zile`, `moe`, `joe`)
* [ ] Port NoteWrapper to other editors (non-exhaustive list of planned ports: `emacs -nw`, `micro`, `jed`, `ad`, flow-control, `ee`, `amp`, `dte`, `cano`, `mle`, `zee`, `ptext`, `kibi`, `ox`, `ne`, `nvi`, `dit`, `zile`, `moe`, `joe`)
* [ ] Default to $EDITOR