zk

纯文本笔记助手

描述

zk是一个命令行工具，可帮助您维护纯文本 Zettelkasten 或个人 wiki。

正在寻找快速使用示例？

或者想看看它的实际效果？查看 Shivan 的视频“所有程序员都应该考虑的笔记系统” 。

亮点

注意：以下列表中的链接是出站链接 ↗

• 从模板创建笔记
• 高级搜索和过滤功能，包括标签、链接和提及
• 与您最喜欢的编辑器集成：
  • 任何与 LSP 兼容的编辑器
  • zk-nvim适用于 Neovim 0.8+
  • 用于 Visual Studio Code 的zk-vscode
• 交互式浏览器，由fzf提供支持
• Git 风格的命令别名和命名过滤器
• 考虑到自动化而制造
• 笔记本管家
• 面向未来，得益于 Markdown
• 支持大多数 Markdown 语法风格
  • 链接：常规 Markdown 链接、 [[Wikilinks]]和 Neuron 的[[Folgezettel links]]# 。
  • 标签： #hashtags 、 :colon:separated:tags: 、Bear 的#multi-word tags# 。
  • YAML 前沿问题

请参阅变更日志，了解即将发布的即将发布的功能列表。

zk不是什么

• 笔记编辑器。
• 一个在网络上提供笔记的工具 - 为此，您可能对 Neuron 或 Gollum 感兴趣。

安装

查看适用于 macOS 和 Linux 的预构建二进制文件的最新版本（ zk尚未在 Windows 上进行测试）。

自制

brew install zk

或者，如果您想了解最新更改：

brew install --HEAD zk

尼克斯

 # Run zk from Nix store without installing it:
nix run nixpkgs#zk
# Or, to install it permanently:
nix-env -iA zk

阿尔卑斯Linux

zk目前在testing存储库中可用：

apk add zk

架构Linux

您可以从官方存储库安装 zk 软件包。

sudo pacman -S zk

从头开始构建

确保您安装了有效的 Go 1.21+，然后克隆存储库：

$ git clone https://github.com/zk-org/zk.git
$ cd zk

在 macOS/Linux 上

 $ make
$ ./zk -h

贡献

我们热烈欢迎问题、PR 和讨论。

在这里您可以阅读一些为zk做出贡献的有用信息。

相关项目

• Neuron – 在网络上发布 Zettelkasten 的绝佳工具
• Emanote – Neuron 的改进后继者
• Sirupsen 的 zk – 具有类似目的的脚本集合
• zk-spaced – zk 的间隔重复插件