diff options
| author | Yann Herklotz <git@yannherklotz.com> | 2020-03-15 17:21:50 +0000 |
|---|---|---|
| committer | Yann Herklotz <git@yannherklotz.com> | 2020-03-15 17:21:50 +0000 |
| commit | 19ff197f95fe1ee3347150c57881a4d02d3f9c9f (patch) | |
| tree | 8997f9c9580051cdbf5239d3623770734144f5f2 | |
| parent | 437aaf1a29b8469a27b44754376bc78b3b61d77c (diff) | |
| download | org-zettelkasten-19ff197f95fe1ee3347150c57881a4d02d3f9c9f.tar.gz org-zettelkasten-19ff197f95fe1ee3347150c57881a4d02d3f9c9f.zip | |
Add documentation and make mode global
| -rw-r--r-- | README.md | 45 | ||||
| -rw-r--r-- | zettelkasten.el | 3 |
2 files changed, 47 insertions, 1 deletions
@@ -1,2 +1,47 @@ # Zettelkasten mode for Emacs +[Zettelkasten](https://zettelkasten.de/) is a note-taking technique designed to keep, and create new links between all the notes as they are written. This allows them to develop over time, link to various different topics and allow the notes to grow into a network over time. This helps draw connections between different fields. + +This emacs mode is meant to allow for a very simple wrapper over linked text files. By default, `org` files are used, which are linked through simple file links. The name of the file that is created is just a unique ID. + +Each file can then link to other files and they can easily be browsed through in emacs. + +## How to use Zettelkasten + +To use Zettelkasten, first create a directory which will contain all your notes. This will be a flat directory, as tags are used to place notes into specific categories. + +``` shell +mkdir ~/zettelkasten +``` + +Then, you can activate the mode as follows. + +```emacs-lisp +(add-to-list 'load-path "/path/to/zettelkasten") +(require 'zettelkasten) +(zettelkasten-mode t) +``` + +### Creating new notes + +A new note can be created using + +``` text +zettelkasten-create-new-note +``` + +which is bound to `C-c k n` by default. + +### Linking to a note + +To link to a note from the current note, use the following command: + +``` text +zettelkasten-insert-link +``` + +which will open a list of available notes which you can choose to link to. + +## Alternatives + +An alternative to use Zettelkasten in emacs is [Zetteldeft](https://github.com/EFLS/zetteldeft), which uses Deft as a backend to search files. diff --git a/zettelkasten.el b/zettelkasten.el index c3d62f3..e390f77 100644 --- a/zettelkasten.el +++ b/zettelkasten.el @@ -146,7 +146,8 @@ If PREFIX is used, does not create a parent." (define-minor-mode zettelkasten-mode "Enable the keymaps to be used with zettelkasten." :lighter " zettelkasten" - :keymap zettelkasten-minor-mode-map) + :keymap zettelkasten-minor-mode-map + :global t) (provide 'zettelkasten) |