2022-10-18 22:55:34 +08:00
# vim-zettelkasten
2024-12-10 21:47:12 +08:00
> _vim-zettelkasten_ is a [Zettelkasten](https://zettelkasten.de) note taking plugin, which is forked from [zettelkasten.nvim@fe174666](https://github.com/Furkanzmc/zettelkasten.nvim/tree/fe1746666e27c2fcc0e60dc2786cb9983b994759).
2022-10-18 22:55:34 +08:00
2024-12-10 21:47:12 +08:00
[](https://spacevim.org)
[](LICENSE)
2022-10-18 22:55:34 +08:00
2024-12-10 21:47:12 +08:00
<!-- vim - markdown - toc GFM -->
2022-10-18 22:55:34 +08:00
2024-12-10 21:47:12 +08:00
- [Install ](#install )
2024-12-18 00:46:21 +08:00
- [Usage ](#usage )
- [Screenshots ](#screenshots )
2024-12-10 21:47:12 +08:00
- [Feedback ](#feedback )
2022-10-18 22:55:34 +08:00
2024-12-10 21:47:12 +08:00
<!-- vim - markdown - toc -->
2022-10-18 22:55:34 +08:00
2024-12-10 21:47:12 +08:00
## Install
2022-10-18 22:55:34 +08:00
2024-12-10 21:47:12 +08:00
1. Using `vim-zettelkasten` in SpaceVim:
2022-10-18 22:55:34 +08:00
2024-12-10 21:47:12 +08:00
```toml
[[layers]]
name = 'zettelkasten'
zettel_dir = 'D:\me\zettelkasten'
zettel_template_dir = 'D:\me\zettelkasten_template'
```
2022-10-18 22:55:34 +08:00
2024-12-10 21:47:12 +08:00
2. Using `vim-zettelkasten` without SpaceVim:
2022-10-18 22:55:34 +08:00
2024-12-16 23:25:33 +08:00
```vim
2024-12-10 21:47:12 +08:00
Plug 'wsdjeg/vim-zettelkasten'
2024-12-16 23:25:33 +08:00
let g:zettelkasten_directory = 'D:\me\zettelkasten'
let g:zettelkasten_template_directory = 'D:\me\zettelkasten_template'
2024-12-10 21:47:12 +08:00
```
2022-10-18 22:55:34 +08:00
2024-12-18 00:46:21 +08:00
## 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 |
2024-12-23 23:14:50 +08:00
| `:ZkListNotes` | filte note title in telescope |
2024-12-18 00:46:21 +08:00
**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 |
## Screenshots




2024-12-16 23:25:33 +08:00
2024-12-10 21:47:12 +08:00
## Feedback
2022-10-18 22:55:34 +08:00
2024-12-10 21:47:12 +08:00
The development of this plugin is in [`SpaceVim/bundle/vim-zettelkasten` ](https://github.com/SpaceVim/SpaceVim/tree/master/bundle/vim-zettelkasten ) directory.
2022-10-18 22:55:34 +08:00
2024-12-10 21:47:12 +08:00
If you encounter any bugs or have suggestions, please file an issue in the [issue tracker ](https://github.com/SpaceVim/SpaceVim/issues )