Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/terror/zk
A note-taking tool based on the famous Zettelkasten method
https://github.com/terror/zk
fuzzy-search note-taking rust terminal-based zettelkasten
Last synced: 18 days ago
JSON representation
A note-taking tool based on the famous Zettelkasten method
- Host: GitHub
- URL: https://github.com/terror/zk
- Owner: terror
- License: cc0-1.0
- Created: 2021-02-21T04:39:08.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-06-12T18:57:53.000Z (over 2 years ago)
- Last Synced: 2024-10-11T06:11:25.528Z (about 1 month ago)
- Topics: fuzzy-search, note-taking, rust, terminal-based, zettelkasten
- Language: Rust
- Homepage:
- Size: 376 KB
- Stars: 84
- Watchers: 4
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING
- License: LICENSE
Awesome Lists containing this project
README
## zk
[](https://github.com/terror/zk/actions/workflows/build.yaml)
[](https://crates.io/crates/zkt)
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](https://github.com/lotabout/skim)
- Works with a flat directory of markdown files
- Minimal configuration with sensible defaults
### Demo
Here is a quick demo showcasing the new, search, tag, link and explore
features.
[](https://asciinema.org/a/4TrHLpcAv9lk0RfGngzS6ft3e)
### Installation
You can install `zk` using cargo (note the `zkt` crate name):
```bash
$ cargo install zkt
```
### Usage
```
zk 0.0.3
USAGE:
zk
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
dir Output the Zettelkasten directory path
explore Explore a notes links recursively
find Find notes by tag
link Link two notes
new Create a new note
open Open a note
rm Remove a note
rmlink Remove a link between two notes
rmtag Remove a tag from a note
search Fuzzy search notes
tag Add a tag to a note
help Prints this message or the help of the given subcommand(s)
```
### Configuration
`zk` currently looks for a configuration file called `.zk.toml` using the
[rust-xdg](https://github.com/whitequark/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):
```toml
# .zk.toml
# The Zettelkasten directory path.
path = '~/.zk'
# The preferred editor of choice when opening
# and editing notes.
editor = 'vim'
```
### Keybindings
The fuzzy finder `skim` supports the implementation of custom keybindings, this
section documents the custom keybindings that are implemented when using
various commands.
| Command | Keybindings |
|---------|----------------------------------------------------------------------------------|
| explore | `` - Edit the selected note
`Enter` - Explore the selected notes links |
### Related work
[`srid/neuron`](https://github.com/srid/neuron) - Future-proof note-taking and publishing based on Zettelkasten
[`AndrewCopeland/zettelkasten`](https://github.com/AndrewCopeland/zettelkasten) - Creating notes with the zettelkasten note taking method and storing all notes on github
[`sirupsen/zk`](https://github.com/sirupsen/zk) - Zettelkasten on the command-line 📚 🔍