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 的間隔重複插件