Integration with Vim #11
Replies: 7 comments 39 replies
-
|
Brilliant move! Thanks for wanting to chat through this. I've long been following @evantravers' setup for note-taking, in all it's various permutations. I'm still discovering what works best for me for my day to day. I fear that I might be trying to force one tool to handle multiple goals. For instance:
I use Drafts.app on mac and iOS for quick entry of things to then use an action @evantravers wrote to convert the draft (original draft is archived in the drafts app itself) to a zettel/obsidian friendly .md file to then use neovim to edit further. I will also just go to town in prose mode via neovim to just type out blog posts and ideas, etc. |
Beta Was this translation helpful? Give feedback.
-
|
Some tools might definitely be more convenient for certain use cases. I've been a happy user of Diarly and Things before, but I found that keeping everything in the same simple plain text system was helpful to cross-reference things, enable Git versioning and scripting. Here are some stuff I keep in my notebook:
I'm still experimenting things to find the most convenient organization, so far I have my daily notes in So far I've "marketed" |
Beta Was this translation helpful? Give feedback.
-
That's right, at the moment I've been using vimwiki coupled with vim-zettel and notational-fzf-vim. This works great for navigating through my notes and creating links, but a better integration with I'm thinking of building a dedicated Vim plugin eventually, especially since I don't really need the vimwiki part which is large. With a better |
Beta Was this translation helpful? Give feedback.
-
|
I love this idea! I was just thinking through a lightweight lua-based plugin to sit on top of One neat thing might be to use the virtual text to place a related/ref count next to a specific tag or zettel/page link to get a quick glance at how many inter-linked things refer to that specific tag; just a simple example. Anyway, I'll be watching this project even closer, especially as I use it more and get acclimated to it and finding my own workflow. |
Beta Was this translation helpful? Give feedback.
-
|
I am pretty sure that the lightweight lua plugin is the way. As you and I were texting earlier Seth… the key features:
@mickael-menu has done the heavy lifting… I feel like a couple aliases and examples and we are off to the races. |
Beta Was this translation helpful? Give feedback.
-
|
I have a grand news; i've tossed together a super quick lua neovim plugin, untested. just wanted to get thoughts and a structure down to start tinkering. I'd love to add you gents as collaborators if interested. |
Beta Was this translation helpful? Give feedback.
-
|
I've added a few things; just a basic skeleton to creating commands: https://github.com/megalithic/zk.nvim/compare/feat/main/impl_first_command Not done, just wanted to get this out there. |
Beta Was this translation helpful? Give feedback.
-
|
That's awesome! Thanks for tackling this, you seem quite knowledgeable about Neovim. 👍 I agree that the lightweight "UX" wrapper feels like the right approach. IMHO, one of the most useful feature from Later on for backlinks and such, I think we can have a highly customizable approach by specifying any number of "dynamic" buffers generated with
By the way these two notes might be relevant for the wrapper: |
Beta Was this translation helpful? Give feedback.
-
|
@mickael-menu and @evantravers I've implemented the first couple of commands.. a way to install While not a huge deal; it will just require, maybe some basic configuration for the plugin, basically defining a notebook dir to use as the base path for all commands to be executed. Thoughts? https://github.com/megalithic/zk.nvim/tree/feat/main/impl_first_command |
Beta Was this translation helpful? Give feedback.
-
|
Brilliant! |
Beta Was this translation helpful? Give feedback.
-
|
Also, @mickael-menu please let me know if you'd prefer to not really have involvement in the plugin dev; in other words, if you don't care to be on the hook for PRs and such :) I'm good to move present PR/feature-branch to You answered some of the main things I needed to know to keep moving. :) |
Beta Was this translation helpful? Give feedback.
-
|
No I'm really enthusiastic about this whole project! I don't know a thing about Lua but I will follow closely your PRs. You don't need to wait for my reviews before merging though. I'm watching your repo so I will see all the issues and PRs. Let me know if you need me to add the "not in a notebook" exit status code. |
Beta Was this translation helpful? Give feedback.
-
|
@mickael-menu i've started some discussions back here: megalithic/zk.nvim#9 Thinking maybe we could move the vim/nvim related discussions there, to keep your repo focused on the core functionality? Anyway, this is super exciting and really looking forward to making use of all of this even further. I've not fully realized my workflow yet; just jumped into this plugin while learning your lib, too. |
Beta Was this translation helpful? Give feedback.
-
|
Sounds good 👌 |
Beta Was this translation helpful? Give feedback.
-
|
Just wanted to give a quick update on where we're at. I just merged the ability |
Beta Was this translation helpful? Give feedback.
-
|
I'm not sure I understand what you mean. Do you have some examples with concrete paths? |
Beta Was this translation helpful? Give feedback.
-
|
@mickael-menu .. i thought it best to just create a loom to hopefully illustrate |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for the screencast, it was definitely helpful! Just so we're on the same page for the terminology, I don't use the term sub or nested notebook. With For the issue you raised, it's a good question and I'm not sure there's a definite answer except a matter of taste / usage.
I think this behavior can be helpful with Neovim, if you call This would be a good basic behavior IMHO, but maybe not so practical if you edit notes across different directories, or if you have an
|
Beta Was this translation helpful? Give feedback.
-
|
While I think two "quick" keybindings make sense depending on your usage, the interactive
In any case, we'll probably need to refine all this after some daily practice ;) |
Beta Was this translation helpful? Give feedback.
-
|
@megalithic I just merged in the internal link formatter in $ zk list --quiet --format "{{link}}" --working-dir `pwd`/docs `pwd`/docs/automation.md
[Automating frequent tasks](automation.md)I used The LSP server uses this new link formatter to follow the user preferences, and is only triggered with double brackets Another use case, generating a valid Markdown list from filtering options: $ zk list --match "link format" --format "* {{link}}"
* [Note formats](note-format.md)
* [Template context when formatting a note](template-format.md)
* [Changelog](../CHANGELOG.md)
* [Getting started with zk](getting-started.md)
* [Template syntax](template.md)
* [Send notes for processing by other programs](external-processing.md)
* [Notebook housekeeping](notebook-housekeeping.md)
* [Command aliases](config-alias.md)
* [Note configuration](config-note.md)Here's a pre-built binary for macOS: zk-v0.3.0-9-g2bb4cbd-macos-x86_64.zip |
Beta Was this translation helpful? Give feedback.
-
|
This is what I'm using for navigating notes, tags, links in neovim. It basically shells out https://github.com/mhanberg/.dotfiles/blob/main/config/nvim/plugin/zk.lua local nnoremap = require("motch.utils").nnoremap
local _ = require("underscore")
vim.cmd([[command! ZkDaily :term zk daily]])
local colors = require("ansicolors")
local zk = {}
zk.note_picker = function(source)
local notes = vim.fn.system(source)
if vim.fn.trim(notes) == "" then
notes = "[]"
end
notes = vim.fn.json_decode(notes)
notes = _.map(notes, function(n)
local tags = _.join(
_.map(n.tags, function(t)
return "#" .. t
end),
" "
)
return colors.noReset("%{bright}%{yellow}")
.. n.title
.. colors("%{reset}")
.. " "
.. ":"
.. " "
.. tags
.. " "
.. ":"
.. " "
.. n.absPath
end)
local actions = {
["enter"] = function(selected)
vim.fn.execute("edit " .. selected)
end,
["ctrl-v"] = function(selected)
vim.fn.execute("vsplit " .. selected)
end,
["ctrl-x"] = function(selected)
vim.fn.execute("split " .. selected)
end,
["ctrl-n"] = function(_, query)
require("lspconfig/configs").zk.new({ title = query })
end,
}
FZF({
source = notes,
sinklist = function(selected)
local query = selected[1]
local action = actions[selected[2]]
local parts = vim.fn.split(selected[3], ":")
action(parts[#parts], query)
end,
options = {
"--expect",
"enter,ctrl-v,ctrl-x,ctrl-n",
"--header",
colors("%{blue}CTRL-N: create a note with the query as title"),
"--print-query",
"--ansi",
"--delimiter",
":",
"--preview",
"bat {-1}",
"--nth",
"1..2",
"--prompt",
"Notes> ",
},
window = { width = 0.9, height = 0.6, yoffset = 0, highlight = "Normal" },
})
end
zk.list = function()
zk.note_picker("zk list --quiet -f json --sort=created")
end
zk.tags = function()
local tags = vim.fn.system("zk tag list --quiet -f json")
tags = _.map(vim.fn.json_decode(tags), function(t)
return t.name
end)
FZF({
source = tags,
sink = function(tag)
zk.note_picker(string.format("zk list --quiet -f json --sort=created --tag %s", tag))
end,
options = { "--ansi", "--prompt", "Tags> " },
window = { width = 0.9, height = 0.6, yoffset = 0, highlight = "Normal" },
})
end
zk.backlinks = function()
zk.note_picker(string.format("zk list --quiet -f json --sort=created --link-to %s", vim.fn.expand("%")))
end
zk.links = function()
zk.note_picker(string.format("zk list --quiet -f json --sort=created --linked-by %s", vim.fn.expand("%")))
end
_G.motch.zk = zk
local dir = require("lspconfig").util.root_pattern(".zk")(vim.fn.getcwd())
if type(dir) == "string" then
nnoremap("<C-p>", ":lua motch.zk.list()<cr>")
nnoremap("<space>zt", ":lua motch.zk.tags()<cr>")
nnoremap("<space>zb", ":lua motch.zk.backlinks()<cr>")
nnoremap("<space>zl", ":lua motch.zk.links()<cr>")
nnoremap("<space>zd", ":ZkDaily<cr>")
endNote: The global |
Beta Was this translation helpful? Give feedback.
-
|
I think those are currently the only two. I assume i would be able to do |
Beta Was this translation helpful? Give feedback.
-
|
Yes, that should work. |
Beta Was this translation helpful? Give feedback.
-
|
@mhanberg I implemented the Take a look at the documentation for the available options, the naming doesn't 100% match the CLI flags. And in particular, you need to provide a |
Beta Was this translation helpful? Give feedback.
-
|
Nice! I was able to update my config to this, which no longer has to shell out to the cli tool. This is probably not the design i'll stick to, but is basically a direct port from cli calls to lsp calls. local nnoremap = require("motch.utils").nnoremap
local _ = require("underscore")
vim.cmd([[command! ZkDaily :term zk daily]])
local colors = require("ansicolors")
local zk = {}
zk.lsp = {}
local command = function(command, ...)
return vim.lsp.buf_request_sync(0, "workspace/executeCommand", {
command = command,
arguments = { vim.api.nvim_buf_get_name(0), ... },
})[1]["result"]
end
zk.lsp.list = function(args)
return command("zk.list", args)
end
zk.lsp.tag_list = function(args)
return command("zk.tag.list", args)
end
zk.note_picker = function(...)
local notes = zk.lsp.list(...) or {}
notes = _.map(notes, function(n)
local tags = _.join(
_.map(n.tags or {}, function(t)
return "#" .. t
end),
" "
)
return colors.noReset("%{bright}%{yellow}")
.. n.title
.. colors("%{reset}")
.. " "
.. ":"
.. " "
.. tags
.. " "
.. ":"
.. " "
.. n.absPath
end)
local actions = {
["enter"] = function(selected)
vim.fn.execute("edit " .. selected)
end,
["ctrl-v"] = function(selected)
vim.fn.execute("vsplit " .. selected)
end,
["ctrl-x"] = function(selected)
vim.fn.execute("split " .. selected)
end,
["ctrl-n"] = function(_, query)
require("lspconfig/configs").zk.new({ title = query })
end,
}
FZF({
source = notes,
sinklist = function(selected)
local query = selected[1]
local action = actions[selected[2]]
local parts = vim.fn.split(selected[3], ":")
action(parts[#parts], query)
end,
options = {
"--expect",
"enter,ctrl-v,ctrl-x,ctrl-n",
"--header",
colors("%{blue}CTRL-N: create a note with the query as title"),
"--print-query",
"--ansi",
"--delimiter",
":",
"--preview",
"bat {-1}",
"--nth",
"1..2",
"--prompt",
"Notes> ",
},
window = { width = 0.9, height = 0.6, yoffset = 0, highlight = "Normal" },
})
end
zk.list = function()
zk.note_picker({ select = { "title", "tags", "absPath" }, sort = { "created" } })
end
zk.tags = function()
local tags = zk.lsp.tag_list()
tags = _.map(tags, function(t)
return t.name
end)
FZF({
source = tags,
sink = function(tag)
zk.note_picker({ select = { "title", "tags", "absPath" }, sort = { "created" }, tags = { tag } })
end,
options = { "--ansi", "--prompt", "Tags> " },
window = { width = 0.9, height = 0.6, yoffset = 0, highlight = "Normal" },
})
end
zk.backlinks = function()
zk.note_picker({ select = { "title", "tags", "absPath" }, sort = { "created" }, linkTo = {vim.fn.expand("%")} })
end
zk.links = function()
zk.note_picker({ select = { "title", "tags", "absPath" }, sort = { "created" }, linkedBy = {vim.fn.expand("%")} })
end
_G.motch.zk = zk
local dir = require("lspconfig").util.root_pattern(".zk")(vim.fn.getcwd())
if type(dir) == "string" then
nnoremap("<C-p>", ":lua motch.zk.list()<cr>")
nnoremap("<space>zt", ":lua motch.zk.tags()<cr>")
nnoremap("<space>zb", ":lua motch.zk.backlinks()<cr>")
nnoremap("<space>zl", ":lua motch.zk.links()<cr>")
nnoremap("<space>zd", ":ZkDaily<cr>")
end |
Beta Was this translation helpful? Give feedback.
-
|
Probably not much better, but I switched my implementation to this local colors = require("ansicolors")
local zk = {}
zk.lsp = setmetatable({}, {
__index = function(_, key)
return function(args, callback)
vim.lsp.buf_request(0, "workspace/executeCommand", {
command = "zk." .. key,
arguments = { vim.api.nvim_buf_get_name(0), args },
}, callback)
end
end,
})
local prepend_hash = function(str)
return "#" .. str
end
local default_opts = function(opts)
return vim.tbl_extend("force", { select = { "title", "tags", "absPath" }, sort = { "created" } }, opts or {})
end
zk.note_picker = function(...)
zk.lsp.list(default_opts(...), function(err, result)
if err then
vim.api.nvim_err_write("Error fetching notes from zk: " .. vim.inspect(err))
return
end
local notes = vim.tbl_map(function(n)
local sep = " "
local tags = vim.fn.join(vim.tbl_map(prepend_hash, n.tags or {}), sep)
return colors.noReset("%{bright}%{yellow}")
.. n.title
.. colors("%{reset}")
.. " "
.. ":"
.. " "
.. tags
.. " "
.. ":"
.. " "
.. n.absPath
end, result)
local actions = {
["enter"] = function(selected)
vim.fn.execute("edit " .. selected)
end,
["ctrl-v"] = function(selected)
vim.fn.execute("vsplit " .. selected)
end,
["ctrl-x"] = function(selected)
vim.fn.execute("split " .. selected)
end,
["ctrl-n"] = function(_, query)
require("lspconfig/configs").zk.new({ title = query })
end,
}
FZF({
source = notes,
sinklist = function(selected)
local query = selected[1]
local action = actions[selected[2]]
local parts = vim.fn.split(selected[3], ":")
action(parts[#parts], query)
end,
options = {
"--expect",
"enter,ctrl-v,ctrl-x,ctrl-n",
"--header",
colors("%{blue}CTRL-N: create a note with the query as title"),
"--print-query",
"--ansi",
"--delimiter",
":",
"--preview",
"bat {-1}",
"--nth",
"1..2",
"--prompt",
"Notes> ",
},
window = { width = 0.9, height = 0.6, yoffset = 0, highlight = "Normal" },
})
end)
end
zk.list = zk.note_picker
zk.tags = function()
zk.lsp["tag.list"](nil, function(err, result)
if err then
vim.api.nvim_err_write("Error fetching tags from zk: " .. vim.inspect(err))
return
end
local tags = vim.tbl_map(function(t)
return t.name
end, result)
FZF({
source = tags,
sink = function(tag)
zk.note_picker({ tags = { tag } })
end,
options = { "--ansi", "--prompt", "Tags> " },
window = { width = 0.9, height = 0.6, yoffset = 0, highlight = "Normal" },
})
end)
end
zk.backlinks = function()
zk.note_picker({ linkTo = { vim.fn.expand("%") } })
end
zk.links = function()
zk.note_picker({ linkedBy = { vim.fn.expand("%") } })
end
_G.motch.zk = zk |
Beta Was this translation helpful? Give feedback.
-
|
Here is my cleaned up integration of the current zk lsp commands (new, list, tags.list) and fzf. I realized it made more sense to separate a "zk" file from a "notes" file that does the actual fzf integration. https://github.com/mhanberg/.dotfiles/blob/main/config/nvim/lua/motch/zk.lua |
Beta Was this translation helpful? Give feedback.
-
|
Nice, thanks! Last time I tried using your config I was a bit confused by this Would you mind sharing how to use your config with regular vim-plug for the dependency management? |
Beta Was this translation helpful? Give feedback.
-
|
Haha!
the code located in the code located in I can extract it into a plugin real quick to make it easier to try without needing random stuff from my own config. |
Beta Was this translation helpful? Give feedback.
-
That makes sense now 😁
It would be appreciated! And could be a nice way to really quickstart https://github.com/mickael-menu/zk-nvim |
Beta Was this translation helpful? Give feedback.
-
|
Let me know if you're able to get this installed and running: https://github.com/mhanberg/zk.nvim |
Beta Was this translation helpful? Give feedback.
-
|
@mhanberg Yes it's working great, thanks, I'll explore this! |
Beta Was this translation helpful? Give feedback.
-
|
Pushed some updates to my zk.nvim plugin and included some links to examples in my dotfiles how i'm using it for some more bespoke things. |
Beta Was this translation helpful? Give feedback.
-
|
I'd like to figure out a way to visualize the |
Beta Was this translation helpful? Give feedback.
-
|
By the way there has been some discussion and work done on zk-org/zk-nvim#5, it's using Telescope but I think we could have both fzf and telescope support as an opt-in basis. More importantly, each fuzzy finder plugin could share a common wrapper around the LSP server.
Yeah I've been thinking about this too but couldn't find a satisfying solution for a TUI. I opened a dedicated discussion to talk about this: https://github.com/mickael-menu/zk/discussions/125 |
Beta Was this translation helpful? Give feedback.
-
Oh for sure, I knew there was some WIP on that and didn't want to submit anything until they had time to get started. |
Beta Was this translation helpful? Give feedback.
-
|
Sounds good! Feel free to chime in in the discussions |
Beta Was this translation helpful? Give feedback.
-
@megalithic started this discussion in https://github.com/mickael-menu/zk/issues/10#issuecomment-799666109
Beta Was this translation helpful? Give feedback.
All reactions