aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 91b664ec37800ebcda0a2f0146678748cd7a4c16 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
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.