jonas/telekasten.nvim
1
0
Fork 0
mirror of https://github.com/Ascyii/telekasten.nvim.git synced 2026-01-01 06:14:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Rene Schallner
2021-11-21 21:50:26 +01:00
parent 8e324ebe20
commit f3b4f6d9e2
2 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -11,7 +11,7 @@ Every navigation action, like following a link, is centered around a Telescope s
### The preview is a powerful feature ### The preview is a powerful feature
Leaving the opening of the note to Telescope, you can decide with one keypress whether you want to open the note in a split or in the current window - or if you've seen enough. Leaving the opening of the note to Telescope, you can decide with one keypress whether you want to open the note in a split or in the current window - or if you've seen enough.
I find that pressing the enter key to confirm the search does not interrupt my flow, and I really enjoy being able to check the preview. I often get enough information from the preview so I don't actually have to "visit" every note in terms of being able to edit it. I find that pressing the enter key to confirm the search does not interrupt my flow, and I really enjoy being able to check the preview. I often get enough information from the it alone so I don't actually have to "visit" every note in terms of being able to edit it.
## Install and setup ## Install and setup
@@ -27,7 +27,7 @@ Plugin 'renerocksai/telekasten.nvim'
### 2. Configure telekasten.nvim ### 2. Configure telekasten.nvim
Somewhere in your vim config, put a snippet like this: Somewhere in your vim config, put a snippet like this:
```vimscript ```lua
lua << END lua << END
local home = vim.fn.expand("~/zettelkasten") local home = vim.fn.expand("~/zettelkasten")
require('telekasten').setup({ require('telekasten').setup({
@@ -180,8 +180,10 @@ nnoremap <leader>zt :lua require('telekasten').goto_today()<CR>
nnoremap <leader>zw :lua require('telekasten').find_weekly_notes()<CR> nnoremap <leader>zw :lua require('telekasten').find_weekly_notes()<CR>
nnoremap <leader>zn :lua require('telekasten').new_note()<CR> nnoremap <leader>zn :lua require('telekasten').new_note()<CR>
" note: we define [[ in **insert mode** to call insert link " we could define [[ in **insert mode** to call insert link
inoremap [[ <ESC>:lua require('telekasten').insert_link()<CR> " inoremap [[ <ESC>:lua require('telekasten').insert_link()<CR>
" alternatively: leader [
inoremap <leader>[ <ESC>:lua require('telekasten').insert_link()<CR>
``` ```
## The hardcoded stuff ## The hardcoded stuff

2
lua/telekasten.lua
View File

@@ -322,7 +322,7 @@ end
-- find the file linked to by the word under the cursor -- find the file linked to by the word under the cursor
-- --
SearchNotes = function(opts) SearchNotes = function(opts)
input opts = {} or opts opts = {} or opts
if (check_local_finder() == true) then if (check_local_finder() == true) then
builtin.live_grep({ builtin.live_grep({