README

   1 zk.zsh -- zettelkästen/wiki/static website helper/generator
   2
   3 * Use plain text files. One file per note/record
   4 * Use CamelCase names, that are friendly with vi editor word
   5   boundary determination
   6 * You can safely place that notes in subdirectories hierarchy
   7 * Edit and view your notes from their root path (zettelkästen
   8   root). That way if you press "gf" on "Foo/Bar/Baz" word in
   9   Vim, then it will open Foo/Bar/Baz file in current window
  10 * Use expand("%:r") function to get current file path relative
  11   to the root
  12 * Place links to another notes inside square brackets. You can
  13   highlight them with:
  14     syntax region zkLink start="\[\S" end="\S]"
  15     highlight link zkLink String
  16 * Use Vim's filename completion (:help compl-filename) to
  17   complete directories and filenames in them
  18 * fzf (https://github.com/junegunn/fzf) related tools can be
  19   used to navigate among existing notes
  20 * Ordinary grep, git-jump or similar tools can be used to search
  21   and quickly open results in the editor
  22
  23 The only thing Vim lacks there is ability to tell who backlinks
  24 to the specified page. zk.zsh can be used to show what pages
  25 backlinks to specified page and what pages are referenced by it:
  26     $ zk.zsh links some/page
  27     Another/Page
  28     SomePage
  29     $ zk.zsh backs some/page
  30     [...]
  31 That can be used to make categories and tags on notes. If note
  32 contains a link to category/tag (even an empty file), then it
  33 will be backlinked.
  34
  35     $ zk.zsh htmls path/to/dir
  36 Will convert all your notes to HTMLs with properly created links
  37 to other pages. It also will include all backlinks in them. Each
  38 directory will also contain index page with links to all
  39 existing pages in current directory and to subdirectories.
  40
  41 If ZK_CACHE environment variable contains path to some
  42 directory, then it will keep caching information for speeding up
  43 the processes in it. Look for CACHE file for more information.