aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Herklotz <git@yannherklotz.com>2023-01-08 17:10:32 +0000
committerYann Herklotz <git@yannherklotz.com>2023-01-08 17:10:32 +0000
commit70d636eeb69e373be396304b3fbe783834055b66 (patch)
tree95cfb65c265c2a00100a5e66248128c8f73a7fc1
parenta0fe037f35f42395d856a12d1492026e290ee28a (diff)
downloademacs-zettelkasten-70d636eeb69e373be396304b3fbe783834055b66.tar.gz
emacs-zettelkasten-70d636eeb69e373be396304b3fbe783834055b66.zip
Update README with warning that project moved
-rw-r--r--README.md91
1 files changed, 19 insertions, 72 deletions
diff --git a/README.md b/README.md
index d1b4dac..6faa6d7 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,23 @@
# Zettelkasten mode for Emacs
[![melpazoid](https://github.com/ymherklotz/emacs-zettelkasten/actions/workflows/melpazoid.yml/badge.svg)](https://github.com/ymherklotz/emacs-zettelkasten/actions/workflows/melpazoid.yml)
+[![MELPA](https://melpa.org/packages/zettelkasten-badge.svg)](https://melpa.org/#/zettelkasten)
-| Package | Melpa |
-|---|---|
-| `org-zettelkasten` | [![MELPA](https://melpa.org/packages/org-zettelkasten-badge.svg)](https://melpa.org/#/org-zettelkasten) |
-| `zettelkasten` | [![MELPA](https://melpa.org/packages/zettelkasten-badge.svg)](https://melpa.org/#/zettelkasten) |
+| **Important:** The `org-zettelkasten` package has now moved to [sourcehut](https://sr.ht/~ymherklotz/org-zettelkasten). The packages have been separated as they do not share any code anymore. |
+|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
[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.
-The idea of this mode is to integrate fully into Emacs Org mode, trying to leverage most of its
-preexisting features. It is split into two modes, the main one being `org-zettelkasten`, and a
-secondary standalone mode called `zettelkasten` which is a minimal implementation of existing
-Zettelkasten modes.
+The idea of this mode is to integrate fully into Emacs, trying to leverage most of its preexisting
+features. This package contains `zettelkasten` which is a minimal implementation of existing
+Zettelkasten modes. `org-zettelkasten` is another implementation which is hosted on
+[sourcehut](https://sr.ht/~ymherklotz/org-zettelkasten) and used to be included in this repository,
+it provides helper functions to turn standard [Org](https://orgmode.org/) into a Zettelkasten.
+
+I am currently actively using `org-zettelkasten`, but will still be maintaining `zettelkasten` too.
## `org-zettelkasten` and `zettelkasten`
@@ -24,61 +26,6 @@ giving two different ways to use the Zettelkasten method in Emacs. One (`org-ze
leverages emacs' [`org-mode`](https://orgmode.org/), and the other (`zettelkasten`) is an
implementation from scratch, which can either use `org-mode` files or markdown files as a base.
-## How to use `org-zettelkasten`
-
-The method implemented in `org-zettelkasten` has been described in detail in a [blog
-article](https://yannherklotz.com/blog/2020-12-21-introduction-to-luhmanns-zettelkasten.html). It
-leverages `org-mode` features such as `CUSTOM_ID`,
-
-**Manual Installation**
-
-``` emacs-lisp
-(add-to-list 'load-path "/path/to/org-zettelkasten.el")
-(require 'org-zettelkasten)
-(add-hook 'org-mode-hook #'org-zettelkasten-mode)
-```
-
-**`use-package` from Melpa**
-
-``` emacs-lisp
-(use-package org-zettelkasten
- :ensure t
- :config
- (add-hook 'org-mode-hook #'org-zettelkasten-mode))
-```
-
-### Tag search
-
-Tag search can be implemented using your favourite completion framework. These will use the `ID` at
-the current heading and will look for any other notes that reference this heading (i.e. it will find
-all the back links of the current heading).
-
-#### Tag search with counsel
-
-``` emacs-lisp
-(defun org-zettelkasten-search-current-id ()
- "Use `counsel-rg' to search for the current ID in all files."
- (interactive)
- (let ((current-id (org-entry-get nil "CUSTOM_ID")))
- (counsel-rg (concat "#" current-id) org-zettelkasten-directory "-g *.org" "ID: ")))
-```
-
-#### Tag search with consult
-
-``` emacs-lisp
-(defun org-zettelkasten-search-current-id ()
- "Use `consult-ripgrep' to search for the current ID in all files."
- (interactive)
- (let ((current-id (org-entry-get nil "CUSTOM_ID")))
- (consult-ripgrep org-zettelkasten-directory (concat "[\\[:]." current-id "\\]#"))))
-```
-
-#### Add search to keymap
-
-``` emacs-lisp
-(define-key org-zettelkasten-mode-map (kbd "s") #'org-zettelkasten-search-current-id)
-```
-
## How to use `zettelkasten`
To use Zettelkasten, first create a directory which will contain all your notes. This will be a flat
@@ -93,7 +40,7 @@ Then, you can activate the mode as follows:
**Manual Installation**
```emacs-lisp
-(add-to-list 'load-path "/path/to/zettelkasten.el")
+(add-to-list 'load-path "/path/to/emacs-zettelkasten")
(require 'zettelkasten)
(zettelkasten-mode t)
```
@@ -109,7 +56,7 @@ Then, you can activate the mode as follows:
### Creating new notes
-A new note can be created using
+A new note can be created using:
``` text
M-x zettelkasten-create-new-note
@@ -141,13 +88,13 @@ default.
The default keymap for the mode is `C-c k`, this can easily be changed though by editing
`zettelkasten-prefix`.
-| Function | Key | Description |
-|---|---|---|
-| `zettelkasten-create-new-note` | `n` | Create a new note and optionally link it to a parent. This can be disabled by using a prefix argument. |
-| `zettelkasten-insert-link` | `i` | Insert a link to a note. |
-| `zettelkasten-find-parent` | `p` | Choose from a list of parents of the current note and open the note. |
-| `zettelkasten-open-note` | `o` | Open a note from anywhere, using auto complete on the ID or TITLE of the note. |
-| `zettelkasten-open-note-by-tag` | `t` | Open a note using a tag as the first identifier. |
+| Function | Key | Description |
+|---------------------------------|-----|--------------------------------------------------------------------------------------------------------|
+| `zettelkasten-create-new-note` | `n` | Create a new note and optionally link it to a parent. This can be disabled by using a prefix argument. |
+| `zettelkasten-insert-link` | `i` | Insert a link to a note. |
+| `zettelkasten-find-parent` | `p` | Choose from a list of parents of the current note and open the note. |
+| `zettelkasten-open-note` | `o` | Open a note from anywhere, using auto complete on the ID or TITLE of the note. |
+| `zettelkasten-open-note-by-tag` | `t` | Open a note using a tag as the first identifier. |
## Alternatives