https://github.com/wsdjeg/zettelkasten.nvim
a Zettelkasten note taking plugin
https://github.com/wsdjeg/zettelkasten.nvim
neovim-plugin zettelkasten
Last synced: 14 days ago
JSON representation
a Zettelkasten note taking plugin
- Host: GitHub
- URL: https://github.com/wsdjeg/zettelkasten.nvim
- Owner: wsdjeg
- License: gpl-3.0
- Created: 2024-12-10T14:16:36.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-04-22T23:57:22.000Z (14 days ago)
- Last Synced: 2025-04-23T00:28:31.420Z (14 days ago)
- Topics: neovim-plugin, zettelkasten
- Language: Lua
- Homepage:
- Size: 62.5 KB
- Stars: 20
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - wsdjeg/zettelkasten.nvim - a Zettelkasten note taking plugin (Lua)
README
# zettelkasten.nvim
> _zettelkasten.nvim_ is a [Zettelkasten](https://zettelkasten.de) note taking plugin, which is forked from [zettelkasten.nvim@fe174666](https://github.com/Furkanzmc/zettelkasten.nvim/tree/fe1746666e27c2fcc0e60dc2786cb9983b994759).
* [Install](#install)
* [Usage](#usage)
* [Debug](#debug)
* [Screenshots](#screenshots)
* [Feedback](#feedback)
## Install
1. Using `zettelkasten.nvim` in SpaceVim:
```toml
[[layers]]
name = 'zettelkasten'
zettel_dir = 'D:\me\zettelkasten'
zettel_template_dir = 'D:\me\zettelkasten_template'
```
2. Using `zettelkasten.nvim` without SpaceVim:
```vim
Plug 'wsdjeg/zettelkasten.nvim'
let g:zettelkasten_directory = 'D:\me\zettelkasten'
let g:zettelkasten_template_directory = 'D:\me\zettelkasten_template'
```
3. Using [nvim-plug](https://github.com/wsdjeg/nvim-plug):
```lua
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', 'mzb', 'ZkBrowse', { silent = true })
vim.keymap.set('n', 'mzn', 'ZkNew', { silent = true })
vim.keymap.set('n', 'mzf', 'ZkListNotes', { silent = true })
vim.keymap.set('n', 'mzt', 'ZkListTags', { 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 |
| `` | 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:
```lua
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](https://github.com/wsdjeg/zettelkasten.nvim/issues)