Skip to content

A Zettelkasten system! Or rather, some functions on top of the emacs deft package.

License

Notifications You must be signed in to change notification settings

EFLS/zetteldeft

Repository files navigation

Zetteldeft

http://melpa.org/packages/zetteldeft-badge.svg


UPDATE 2023: Zetteldeft is no longer in active development, as its main author is moving away from a note-taking system based on Deft towards one based on Denote. The Emacs package and this repository will remain available, but might no longer receive updates.


The zetteldeft.org file in this repository contains documented code for a set of functions for emacs, which aims to extend the deft package and turn it into a (very very) basic Zettelkasten note-taking system.

The best way to get to know Zetteldeft, is from within Zetteldeft. Get started by cloning the zd-tutorial repository, available at https://github.com/EFLS/zd-tutorial. Bootstrap use-package installation instructions included.

If you’d rather start with an introduction of key concepts and basic functions, check out an introduction here: efls.github.io/zetteldeft.

Documentation, literate code and further technical details can be found in the .org file of this repository, or can be read in a more convenient format over at efls.github.io/zetteldeft/zetteldeft.html.

zetteldeft is available on MELPA. If you use use-package, installing is as easy as

(use-package zetteldeft
  :after deft
  :config
    (zetteldeft-set-classic-keybindings))

Please note that this was originally written for personal use and that I’m far from an emacs lisp expert. That said, contributions and feedback are more than welcome.