https://github.com/EFLS/zetteldeft

A Zettelkasten system! Or rather, some functions on top of the emacs deft package.
https://github.com/EFLS/zetteldeft

emacs org-mode spacemacs zettelkasten

Last synced: 16 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/EFLS/zetteldeft
• Owner: EFLS
• License: gpl-3.0
• Created: 2018-07-09T19:59:14.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-17T19:52:31.000Z (over 1 year ago)
• Last Synced: 2024-02-17T08:35:36.173Z (9 months ago)
• Topics: emacs, org-mode, spacemacs, zettelkasten
• Language: Emacs Lisp
• Homepage: https://efls.github.io/zetteldeft
• Size: 1.47 MB
• Stars: 386
• Watchers: 17
• Forks: 43
• Open Issues: 43
• Metadata Files:
  • Readme: README.org
  • Contributing: CONTRIBUTING.org
  • License: LICENSE

Awesome Lists containing this project

README

        
#+title: Zetteldeft

#+author: EFLS

#+HTML_HEAD: 

[[http://melpa.org/#/zetteldeft][file: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: [[https://efls.github.io/zetteldeft/][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 [[https://efls.github.io/zetteldeft/zetteldeft.html][efls.github.io/zetteldeft/zetteldeft.html]].

=zetteldeft= is available on [[https://melpa.org/#/zetteldeft][MELPA]].

If you use =use-package=, installing is as easy as

#+begin_src emacs-lisp

(use-package zetteldeft

  :after deft

  :config

    (zetteldeft-set-classic-keybindings))

#+end_src

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.