This is a Vim plugin that implements ideas of the Zettelkasten method using Vimwiki. It supports both Vimwiki and Markdown syntaxes.
Main features:
- customizable filenames (date and time, title, consecutive numbering)
- links always show titles, regardless of the actual filename
- fulltext support using FZF for searching and hyperlinking
- search your Zettelkasten from LaTeX or Markdown documents and insert selected notes to the document
- template support
- automatically updated tag index
- backlinks
You can read the full documentation using
:help vim-zettel
command in Vim after package installation.
Using Vundle:
Plugin 'vimwiki/vimwiki'
Plugin 'junegunn/fzf'
Plugin 'junegunn/fzf.vim'
Plugin 'michal-h21/vim-zettel'
Silver Searcher is used for searching in the notes by default.
The used command can be changed by setting the g:zettel_fzf_command
variable.
Vim-zettel
adds some commands and mappings on top of
Vimwiki. See Vimwiki documentation on how to set up a
basic wiki and navigate it.
The following packages may be useful in conjunction with Vimwiki and Vim-zettel:
- Notational FZF - fast searching
notes with preview window. Similar functionality is now built in in
Vim-Zettel
using:ZettelOpen
command.
To search in the Zettelkasten, set the following variable with path to the Zettelkasten direcory in .vimrc
:
let g:nv_search_paths = ['/path/to/zettelkasten/dir']
- Vimwiki-sync - automatically commit changes in wiki and synchronize them with external Git repository.