summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorYann Herklotz <git@yannherklotz.com>2023-04-23 17:55:50 +0100
committerYann Herklotz <git@yannherklotz.com>2023-04-23 17:56:59 +0100
commitcf96c303c1feeb3821a20077bb6ffb80085ccc4e (patch)
treed3d1c6f41912f85a76137c44c9b3663cf89e4a47 /doc
parent50c092f0a22981e2e447dd421aa474fbc9b384ba (diff)
downloadorg-zettelkasten-cf96c303c1feeb3821a20077bb6ffb80085ccc4e.tar.gz
org-zettelkasten-cf96c303c1feeb3821a20077bb6ffb80085ccc4e.zip
Add introduction guide and persistent mapping index
Diffstat (limited to 'doc')
-rw-r--r--doc/org-zettelkasten-manual.org42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/org-zettelkasten-manual.org b/doc/org-zettelkasten-manual.org
index 18fd15d..61befd5 100644
--- a/doc/org-zettelkasten-manual.org
+++ b/doc/org-zettelkasten-manual.org
@@ -117,6 +117,48 @@ cannot keep track of all the possible links.
- =org-zettelkasten-counsel-search-current-id= :: Alternative to
=org-zettelkasten-search-current-id= using Ripgrep integration with Counsel.
+* Getting Started
+:PROPERTIES:
+:DESCRIPTION: Functions used and provided to navigate org-zettelkasten links.
+:END:
+#+cindex: getting-started
+
+To install =org-zettelkasten=, first make sure that you have the melpa
+repository set-up properly. Then, the following =use-package= declaration will
+set-up =org-zettelkasten= including useful hooks to activate it when it enters a
+zettelkasten file.
+
+#+begin_src emacs-lisp
+ (use-package org-zettelkasten
+ :after org
+ :config
+ (org-zettelkasten-setup))
+#+end_src
+
+Once =org-zettelkasten= is installed properly, then you can run
+=org-zettelkasten-new-topic= to create your first topic file. Make sure that
+the folder in =org-zettelkasten-directory= exists, which is set to
+=~/org-zettelkasten= by default.
+
+This should open a new file with the name that was given in the prompt, and it
+should to start experimenting with adding new notes. In the current file there
+should already be a heading with an ID:
+
+#+begin_src org-mode
+ #+title:
+
+ * First Note
+ :PROPERTIES:
+ :CUSTOM_ID: 1a
+ :END:
+#+end_src
+
+Placing the point anywhere underneath the heading =* First Note=, and pressing
+=C-c y n= will create a next note with a new ID, and jump to it. Going back to
+=* First Note= and pressing the keybinding again will create another note, but
+this time it is nested in the current note (branching) because there is already
+a next note present.
+
* GNU Free Documentation License
:PROPERTIES:
:APPENDIX: t