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

Update README

This commit is contained in:
Marty Oehme 2021-05-20 14:13:09 +02:00
parent 892c1c9edb
commit 20d8edb800
Signed by: Marty
GPG Key ID: B7538B8F50A1C800
1 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,19 +1,27 @@
# Zettelkasten.nvim # Zettelkasten.nvim
To develop / debug: A simple Zettelkasten plugin.
start neovim with `nvim --cmd "set rtp+=$(pwd)" .` to automatically load the files in project dir as if they were on path Currently allows note link creation
(automatically appending a time-based anchor to each created note)
in markdown and wiki-link style, as well as following links to other notes,
wherever they are in the notes directory.
Not much more has been implemented yet,
but some options can already be configured by the user.
## up next ## up next
* action.lua testing? * action.lua testing
* note listing
* note jumping (existing to existing)
## TODO: needed functionality ## TODO: needed functionality
* [ ] note creation (new anchor) * [ ] note creation (new anchor)
* [x] create anchor * [x] create anchor
* [ ] *unique* anchor creation * [x] *unique* anchor creation
* [ ] implement custom anchor creation function to go with custom anchor regex * [ ] implement custom anchor creation function to go with custom anchor regex (turn anchor options into objects similar to parsers, to let *them* do the work)
* [x] create link (md / wiki) * [x] create link (md / wiki)
* [ ] note listing (anchors / titles, no anchor) * [ ] note listing (anchors / titles, no anchor)
* [ ] list anchors * [ ] list anchors
@ -27,9 +35,9 @@ start neovim with `nvim --cmd "set rtp+=$(pwd)" .` to automatically load the fi
* [x] allow same command for following/creating link depending on cursor over link or not * [x] allow same command for following/creating link depending on cursor over link or not
* [ ] link switching (point to another existing note) * [ ] link switching (point to another existing note)
* [ ] note search (title / full-text) * [ ] note search (title / full-text)
* [x] jump to zettel (open existing anchor) * [ ] jump to zettel (open existing anchor)
* [x] select by anchor * [ ] select by anchor
* [x] select by link/title match * [ ] select by link/title match
* [ ] Opt: select by fuzzy title match * [ ] Opt: select by fuzzy title match
* [ ] options * [ ] options
* [x] zettel anchor separator * [x] zettel anchor separator
@ -38,7 +46,7 @@ start neovim with `nvim --cmd "set rtp+=$(pwd)" .` to automatically load the fi
* [ ] custom link style? * [ ] custom link style?
* [x] link detection/following (under word, next on line) * [x] link detection/following (under word, next on line)
* [ ] recursive dir lookup for zettel * [ ] recursive dir lookup for zettel
* [ ] zettel anchor regex * [x] zettel anchor regex
## TODO: maintenance ## TODO: maintenance
@ -107,3 +115,7 @@ Since, as long as the api still changes rapidly,
a list of options would quickly be outdated, a list of options would quickly be outdated,
what you can instead is to look into `options.lua`, 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. where at the top the currently effective options with their defaults and available values are defined.
## Developing / Debugging
start neovim with `nvim --cmd "set rtp+=$(pwd)" .` to automatically load the files in project dir as if they were on path