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

up readme and backlog

Browse Source
This commit is contained in:
Rene Schallner
2021-11-21 16:52:44 +01:00
parent 9133271913
commit d58f2187f6
2 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
BACKLOG.md
View File

@@ -1,6 +1,12 @@
# Backlog # Backlog
- follow links: create non-existing ones
- extend markdown syntax highlights for [[links]] - extend markdown syntax highlights for [[links]]
- get rid of `daily_finder.sh` - get rid of `daily_finder.sh`
## Dones
- [x] ,[ to insert link --> we can escape out and type double brackets
- [x] shortcuts for todo and done in init.vim
- [x] Readme search based navigation

9
README.md
View File

@@ -4,6 +4,15 @@ A Neovim (lua) plugin for working with a markdown zettelkasten, based on telesco
Find notes by name, daily notes by date, search within all notes, place and follow links to your notes. Also, creates today's daily note if not present when searching for notes. At the moment, the daily note template is hardcoded though 😁. Find notes by name, daily notes by date, search within all notes, place and follow links to your notes. Also, creates today's daily note if not present when searching for notes. At the moment, the daily note template is hardcoded though 😁.
## Search-based navigation
Every navigation action, like following a link, is centered around a Telescope search: a Telescope search popup is opened, and in the case of following a link, the search-text is pre-filled with the target. So, instead of opening the linked note, you get a preview in Telescope and can decide if you actually want to go there. Since the search is often likely to show up more than one result, you can preview related notes immediately.
### 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.
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.
## Install and setup ## Install and setup
**MS Windows note:** At the moment, telekasten.nvim is unlikely to be able to run on Windows, because it relies on a bash script. Just sayin. Since telekasten.nvim is a project that scratches my own itch, I am not sure if I will add Windows support any time soon. Should anyone read this: Pull requests are welcome 😄! Replacing the daily finder by a proper lua version should do the trick. **MS Windows note:** At the moment, telekasten.nvim is unlikely to be able to run on Windows, because it relies on a bash script. Just sayin. Since telekasten.nvim is a project that scratches my own itch, I am not sure if I will add Windows support any time soon. Should anyone read this: Pull requests are welcome 😄! Replacing the daily finder by a proper lua version should do the trick.