{"repo":"terror/zk","free":true,"listed":false,"github":"https://github.com/terror/zk","clone":"git clone https://github.com/terror/zk.git","description":"A note-taking tool based on the famous Zettelkasten method","language":"Rust","stars":104,"topics":["rust","terminal-based","zettelkasten","note-taking","fuzzy-search"],"license":"CC0-1.0","category":"productivity","readme_excerpt":"zk A note-taking tool based on the famous Zettelkasten method with support for fuzzy searching, tags & link exploration, in Rust! What is a Zettelkasten ? A zettelkasten , or 'slip box' is a method of note-taking famously used by the sociologist Niklas Luhmann. Notes essentially contain metadata such as tags that describe key aspects of the note or links to other notes. The goal is to enhance creativity by exploring the relationships between notes and making new connections between seemingly unrelated ideas. Features - Fast fuzzy search and link exploration powered by skim - Works with a flat directory of markdown files - Minimal configuration with sensible defaults Here is a quick demo showcasing the new, search, tag, link and explore features. Installation zk should run on most systems, including Linux, MacOS, and the BSDs. Windows support is being worked on! The easiest way to install it is by using cargo, the Rust package manager: Pre-built binaries Pre-built binaries for Linux and MacOS can be found on the releases page. Usage The primary way to use zk is via the provided command-line interface, for which help output is provided below: Configuration zk currently looks for a configuration file called .zk.toml using the rust-xdg crate. If a configuration file is found it must have the following key-value pairs set (default values are shown below if no configuration file is present): Keybindings The fuzzy finder skim supports the implementation of custom keybindings, this s","default_branch":null,"files":null,"tree":[],"storefront":"/r/terror","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/terror/zk/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}