Updated readme with visual toggle todo info

This commit is contained in:
Alexander Lay-Calvert
2022-09-27 16:03:55 -04:00
parent 5b460a07a0
commit 4340762d48
2 changed files with 9 additions and 0 deletions

View File

@@ -661,6 +661,10 @@ The plugin defines the following functions:
- this function accepts a parameter `{i}`. If `true`, it will enter input mode by pressing the 'A' key. This is
useful when being used in a simple `inoremap` key mapping like shown in [Bind it](#3-bind-it).
- example: `toggle_todo({ i=true })`
- this function can also be used in `visual` mode to toggle the status of multiple lines.
- if using a keymapping to `toggle_todo` in visual mode, make sure to use `:Telekasten toggle_todo<CR>`
instead of `<cmd>Telekasten toggle_todo<CR>` to avoid neovim sending the wrong visual selection to
telekasten.
- `show_backlinks()` : opens a telescope search for notes that `[[link]]` back to the current note.
- `find_friends()` : opens a telescope search for notes that also `[[link]]` to the link under the cursor.
- `insert_img_link()` : opens a telescope search for all media (PDFs, images, videos (MP4, webm)) and places a markdown

View File

@@ -649,6 +649,11 @@ telekasten.toggle_todo({opts})~
Turns a line into a `- [ ] ` todo line, or toggle between `- [ ]`, `- [x]`,
and `-` .
This can also be used in visual mode to toggle the status of multiple lines.
If using a keymapping to `toggle_todo` in visual mode, make sure the `rhs` is
`:Telekasten` `toggle_todo<CR>` instead of `<cmd>Telekasten` `toggle_todo<CR>`
to avoid neovim sending the wrong visual selection.
Valid keys for {opts}
i:~