Lib.rs

zk

一个基于著名 Zettelkasten 方法，支持模糊搜索、标签和链接探索的笔记工具，用 Rust 实现！

什么是 Zettelkasten？

Zettelkasten，或称“索引卡片盒”，是社会学学家 Niklas Luhmann 广泛使用的笔记方法。笔记主要包含元数据，如描述笔记关键方面的标签或指向其他笔记的链接。目标是通过对笔记之间关系进行探索，在看似无关的想法之间建立新的联系，从而提高创造力。

功能

• 由 skim 提供的快速模糊搜索和链接探索
• 与平面目录中的 Markdown 文件一起工作
• 最小化配置，默认值合理

演示

以下是一个快速演示，展示了新搜索、标签、链接和探索功能。

安装

您可以使用 cargo 安装 zk（注意 zkt 包名）

$ cargo install zkt

使用方法

zk 0.0.3

USAGE:
    zk <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    dir                    Output the Zettelkasten directory path
    explore <name>         Explore a notes links recursively
    find    <tag>          Find notes by tag
    link    <left> <right> Link two notes
    new     <name>         Create a new note
    open    <name>         Open a note
    rm      <name>         Remove a note
    rmlink  <left> <right> Remove a link between two notes
    rmtag   <name> <tag>   Remove a tag from a note
    search                 Fuzzy search notes
    tag     <name> <tag>   Add a tag to a note
    help                   Prints this message or the help of the given subcommand(s)

配置

zk 目前使用 rust-xdg 包查找名为 .zk.toml 的配置文件。

如果找到配置文件，则必须设置以下键值对（如果不存在配置文件，则显示默认值）

# .zk.toml

# The Zettelkasten directory path.
path = '~/.zk'

# The preferred editor of choice when opening
# and editing notes.
editor = 'vim'

键绑定

模糊搜索器 skim 支持自定义键绑定，本节记录了使用各种命令时实现的自定义键绑定。

相关工作

srid/neuron - 基于 Zettelkasten 的未来派笔记和发布

AndrewCopeland/zettelkasten - 使用 Zettelkasten 笔记法创建笔记，并将所有笔记存储在 GitHub 上

sirupsen/zk - 命令行上的 Zettelkasten 📚 🔍