zettelkasten.nvim

zettelkasten.nvim is a Zettelkasten note taking plugin, which is forked from zettelkasten.nvim@fe174666.

• Install
• Usage
• Debug
• Screenshots
• Feedback

Install

1. Using zettelkasten.nvim in SpaceVim:

[[layers]]
  name = 'zettelkasten'
  zettel_dir = 'D:\me\zettelkasten'
  zettel_template_dir = 'D:\me\zettelkasten_template'

2. Using zettelkasten.nvim without SpaceVim:

Plug 'wsdjeg/zettelkasten.nvim'
let g:zettelkasten_directory = 'D:\me\zettelkasten'
let g:zettelkasten_template_directory = 'D:\me\zettelkasten_template'

3. Using nvim-plug:

require('plug').add({
    {
        'wsdjeg/zettelkasten.nvim',
        config_before = function()
            vim.g.zettelkasten_directory = 'D:/zettelkasten'
            vim.g.zettelkasten_template_directory = 'D:/zettelkasten_template'
        end,
        config = function()
            vim.keymap.set('n', '<leader>mzb', '<cmd>ZkBrowse<cr>', { silent = true })
            vim.keymap.set('n', '<leader>mzn', '<cmd>ZkNew<cr>', { silent = true })
            vim.keymap.set('n', '<leader>mzf', '<cmd>ZkListNotes<cr>', { silent = true })
            vim.keymap.set('n', '<leader>mzt', '<cmd>ZkListTags<cr>', { silent = true })
        end,
    },
})

Usage

Commands:

Command	description
:ZkNew	create new note
:ZkBrowse	list note in browser window
:ZkListTags	filter tags in telescope
:ZkListTemplete	filte note templates in telescope
:ZkListNotes	filte note title in telescope

Key bindings in browser window:

key bindings	description
F2	open zettelkasten tags sidebar
<LeftRelease>	filter notes based on cursor tag
gf	open the note
Ctrl-l	clear tags filter pattarn
Ctrl-] / K	preview note in vim preview-window
[I	list references in quickfix-window

Debug

debug zettelkasten.nvim with logger.nvim:

require('plug').add({
    { 'wsdjeg/zettelkasten.nvim', depends = { { 'wsdjeg/logger.nvim' } } },
})

Screenshots

Feedback

If you encounter any bugs or have suggestions, please file an issue in the issue tracker