1 zk.zsh -- zettelkästen-related helper
3 It can be used as a static website generator, as a wiki.
5 * Use plain text files. One file per note/record
6 * Use CamelCase names, that are friendly with vi editor word
8 * You can safely place that notes in subdirectories hierarchy
9 * Edit and view your notes from their root path (zettelkästen
10 root). That way if you press "gf" on "Foo/Bar/Baz" word in
11 Vim, then it will open Foo/Bar/Baz file in current window
12 * Use expand("%:r") function to get current file path relative
14 * Place links to another notes inside square brackets. You can
16 syntax region zkLink start="\[\S" end="\S]"
17 highlight link zkLink String
18 * Use Vim's filename completion (:help compl-filename) to
19 complete directories and filenames in them
20 * fzf (https://github.com/junegunn/fzf) related tools can be
21 used to navigate among existing notes
22 * Ordinary grep, git-jump or similar tools can be used to search
23 and quickly open results in the editor
25 The only thing Vim lacks there is ability to tell who
26 backreferences to the specified page. zk.zsh can be used to show
27 what pages backreferences to specified page and what pages are
29 $ zk.zsh links some/page
32 $ zk.zsh backs some/page
34 That can be used to make categories and tags on notes. If note
35 contains a link to category/tag, then it will be backreferenced.
37 Currently it does not use any kind of database or cache. It
38 parses all files every time.
40 $ zk.zsh htmls path/to/dir
41 Will convert all your notes to HTMLs with properly created links
42 to other pages. It also will include all backreference links in
43 them. Each directory will also contain Index page with links to
44 all existing pages in current directory and to subdirectories.