From ba04bc7efc9ea434a133afb977172936ebc841d6 Mon Sep 17 00:00:00 2001 From: Laszlo Attila Toth Date: Mon, 11 Dec 2023 19:29:06 +0100 Subject: [PATCH] Update README.org with existing functionality --- README.org | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.org b/README.org index bcfe39f..be7500e 100644 --- a/README.org +++ b/README.org @@ -42,6 +42,12 @@ Put this in your ~init.el~: (obsidian-specify-path "~/MY_OBSIDIAN_FOLDER") ;; If you want a different directory of `obsidian-capture': (setq obsidian-inbox-directory "Inbox") + ;; Clicking on a wiki link referring a non-existing file the file can be + ;; created in the inbox (t) or next to the file with the link (nil). + ;; Default: t - creating in the inbox + ;(setq obsidian-wiki-link-create-file-in-inbox nil) + ;; You may want to define a folder for daily notes. By default it is the inbox. + ;(setq obsidian-daily-notes-directory "Daily Notes") ;; Define obsidian-mode bindings (add-hook @@ -56,10 +62,11 @@ Put this in your ~init.el~: ;; Following backlinks (local-set-key (kbd "C-c C-b") 'obsidian-backlink-jump))) - ;; Optionally you can also bind `obsidian-jump' and `obsidian-capture' + ;; Optionally you can also bind a few functions: ;; replace "YOUR_BINDING" with the key of your choice: - (global-set-key (kbd "YOUR_BINDING") 'obsidian-jump) - (global-set-key (kbd "YOUR_BINDING") 'obsidian-capture) + (global-set-key (kbd "YOUR_BINDING") 'obsidian-jump) ;; Opening a note + (global-set-key (kbd "YOUR_BINDING") 'obsidian-capture) ;; Capturing a new note in the inbox + (global-set-key (kbd "YOUR_BINDING") 'obsidian-daily-note) ;; Creating daily note ;; Activate detection of Obsidian vault (global-obsidian-mode t) @@ -77,6 +84,12 @@ Put this in your ~init.el~: :custom ;; This directory will be used for `obsidian-capture' if set. (obsidian-inbox-directory "Inbox") + ;; Create missing files in inbox? - when clicking on a wiki link + ;; t: in inbox, nil: next to the file with the link + ;; default: t + ;(obsidian-wiki-link-create-file-in-inbox nil) + ;; The directory for daily notes (file name is YYYY-MM-DD.md) + (obsidian-daily-notes-directory "Daily Notes") :bind (:map obsidian-mode-map ;; Replace C-c C-o with Obsidian.el's implementation. It's ok to use another key binding. ("C-c C-o" . obsidian-follow-link-at-point)