zk

プレーンテキストのメモ取りアシスタント

説明

zkプレーン テキストの Zettelkasten または個人 Wiki の保守を支援するコマンド ライン ツールです。

簡単な使用例をお探しですか?

それとも実際に動作しているところを見たいですか? Shivan のビデオ「すべてのプログラマーが考慮すべきメモ取りシステム」をチェックしてください。

ハイライト

注: 以下のリストのリンクは送信用です ↗

• テンプレートからメモを作成する
• タグ、リンク、メンションなどの高度な検索およびフィルタリング機能
• お気に入りのエディターとの統合:
  • LSP 互換のエディター
  • Neovim 0.8+ 用のzk-nvim
  • Visual Studio コード用のzk-vscode
• fzfを搭載した対話型ブラウザ
• Git スタイルのコマンド エイリアスと名前付きフィルター
• 自動化を念頭に置いて作られています
• ノートの整理整頓
• Markdown のおかげで将来も安心
• ほとんどの Markdown 構文フレーバーをサポート
  • リンク: 通常の Markdown リンク、 [[Wikilinks]]および Neuron の[[Folgezettel links]]# 。
  • タグ: #hashtags 、 :colon:separated:tags: 、クマの#multi-word tags# 。
  • YAML のフロントマター

リリースを待っている今後の機能のリストについては、変更ログを参照してください。

zkではないもの

• ノートエディター。
• Web 上でメモを提供するツール – このためには、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

アルパイン・リナックス

zkは現在、 testingリポジトリで利用できます。

apk add zk

Arch 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 – ゼッテルカステンをウェブ上に公開するための優れたツール
• Emanote – Neuron の改良された後継者
• sirupsen の zk – 同様の目的を持つスクリプトのコレクション
• zk-spaced – zk 用の間隔をあけた繰り返しプラグイン