{"id":15667987,"url":"https://github.com/naps62/zk","last_synced_at":"2025-05-05T23:53:27.600Z","repository":{"id":44363179,"uuid":"280535920","full_name":"naps62/zk","owner":"naps62","description":"A simple zettelkasten setup using Vim, fzf and ripgrep","archived":false,"fork":false,"pushed_at":"2021-02-26T11:46:20.000Z","size":65,"stargazers_count":31,"open_issues_count":2,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-19T12:14:10.103Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/naps62.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-17T22:21:16.000Z","updated_at":"2024-12-21T17:29:09.000Z","dependencies_parsed_at":"2022-08-30T05:40:36.949Z","dependency_job_id":null,"html_url":"https://github.com/naps62/zk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/naps62%2Fzk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/naps62%2Fzk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/naps62%2Fzk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/naps62%2Fzk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/naps62","download_url":"https://codeload.github.com/naps62/zk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252596395,"owners_count":21773844,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-03T14:06:05.103Z","updated_at":"2025-05-05T23:53:27.576Z","avatar_url":"https://github.com/naps62.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zettelkasten\n\nA simple Zettelkasten setup using Vim + FZF + Ripgrep\n\n![Zettelkasten](./banner.jpeg)\n\n## What is a zettelkasten?\n\n\u003e The zettelkasten (German: \"slip box\") is a knowledge management and note-taking method used in research and study. \n\n[Wikipedia](https://en.wikipedia.org/wiki/Zettelkasten)\n\nThe zettelkasten method consists of taking multiple individual notes, tagging and relating them together, in order to\nbuild a private knowledge base.\n\n## Why?\n\nI was inspired by [this post](https://superorganizers.substack.com/p/how-to-build-a-learning-machine), and by how the\nauthor built his own setup using Unix tools. I wanted a similar, but slightly different setup.\nBy the way, his work is also [on Github](https://github.com/sirupsen/zk)\n\n## How?\n\n### Philosophy\n\nEach zettel (probably not a real world, but I'll use that to refer to each individual note) is a markdown file, named\nwith a timestamp and a title.\n\nZettels can have tags (e.g.: `#programming`, `#quote`, `#really-good-advice`), as well as sources (e.g.: `@tim-ferriss`,\n`@mom`, `@myself`).\n\nThey're otherwise plain markdown files, write whatever you want, in whatever format you wish. Here's a sample:\n\n```\n# 2020-07-17-11-30-optimization.md\n\nPremature optimization is the root of all evil\n\n**I opted to use markdown italic syntax for personal comments**\n\n#quote #programming\n@donald-knuth\n```\n\nYou can then navigate your knowledge base by searching for tags, sources, or just plain full-text search.\n\nAll of this is powered by:\n- [Vim](https://www.vim.org) ([Neovim](https://neovim.io) works too)\n- [Fzf](https://github.com/junegunn/fzf)\n- [Ripgrep](https://github.com/BurntSushi/ripgrep)\n)\n\nMore tooling may be added down the line, but for now this simple setup serves me well.\n\n### Installation\n\n1. Make sure you have the `fzf`, `rg` commands working on your shell, as well as\n   the [fzf.vim](https://github.com/junegunn/fzf.vim) Vim plugin.\n\n2. Clone the repo to some place:\n\n```sh\ngit clone git@github.com:naps62/zk $HOME/.zk\n```\n\n3. Add the `bin` directory to your path\n\n```sh\n# add this to your .bashrc / .zshrc / .whateverrc\nexport PATH=\"$HOME/.zk/bin:$PATH\"\n```\n\n4. Setup the needed `$ZK_PATH` variable, pointing to where you want your knowledge base to be:\n\n```sh\n# add this to your .bashrc / .zshrc / .whateverrc\nexport ZK_PATH=\"$HOME/zettelkasten\"\n```\n\n5. Start using it\n\n```sh\n# create a new zettel\n$ zk new \"An Awesome Quote\"\n\n# search by tags\n$ zk tags\n\n# search by sources\n$ zk sources\n\n# full-text search the entire zettelkasten\n$ zk search\n\n# get help\n$ zk help\n```\n\n## Contributing\n\nFeel free to do so.\n\nPull requests, issues, or even a [tweet](https://twitter.com/naps62) is welcome.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnaps62%2Fzk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnaps62%2Fzk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnaps62%2Fzk/lists"}