Marty/zettelkasten.nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README

Browse source 
Updated some examples, wordings and ideas.
This commit is contained in:
Marty Oehme 2021-07-26 22:28:24 +02:00
parent aad77cff07
commit 46df48be3f
Signed by: Marty
GPG key ID: B7538B8F50A1C800
1 changed files with 31 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -51,14 +51,15 @@ allows you to separate the link following and creation set above.
Options can currently be set via lua:
```lua
vim.g["zettel_extension"] = ".wiki"
vim.g["zettel_extension"] = ".md"
vim.g["zettel_root"] = "~/documents/notes"
```
or via vimscript:
```vim
let g:zettel_extension = ".wiki"
let g:zettel_root = "~/documents/zettel"
let g:zettel_root = "~/documents/notes"
```
The functionality is the same. The plugin will look up options by precedence buffer > global > default.
@ -74,7 +75,6 @@ a list of options would quickly be outdated,
what you can instead is to look into `options.lua`,
where at the top the currently effective options with their defaults and available values are defined.
## up next
* note listing
@ -119,6 +119,7 @@ where at the top the currently effective options with their defaults and availab
## TODO: maintenance
* [ ] remove hard-coding of option vimnames in tests, now that we can dynamically change this through a single table
* [ ] change options handling, so there's no function having to be invoked every time (`o.zettel().extension`..) (e.g. through initial setup function)
## Anchor Creation
@ -166,7 +167,6 @@ where at the top the currently effective options with their defaults and availab
* [ ] link creation - remove special marks, make customizable (e.g. i- will: help. -> i--will:-help..md [currently] -> i-will-help.md [possibly])
* [ ] option to automatically save on switching zettel, making link jumping/ zettel creation easier
* [ ] function exposed to jump cursor to next/previous link
* [ ] index file functionality
* [ ] several default options (index, home, wiki, ..)
* [ ] optionally look for index file in sub-directories (could allow 'zettel' being directories as well)
@ -174,4 +174,15 @@ where at the top the currently effective options with their defaults and availab
## Developing / Debugging
start neovim with `nvim --cmd "set rtp+=$(pwd)" .` to automatically load the files in project dir as if they were on path
start neovim with `nvim --cmd "set rtp+=$(pwd)" .` to automatically load the files in project dir as if they were on path.
Put the following function in the plugin directory as `debug.vim` or similar and you can instantly reload the plugin during development.
```lua
" TODO for DEBUGGING ONLY: reloads the whole lua plugin
fun! ZKReload()
lua for k in pairs(package.loaded) do if k:match("^zettelkasten") then package.loaded[k] = nil end end
lua require 'zettelkasten'
endfun
nnoremap <leader>R :call ZKReload()<cr>
```