Skip to content

Commit

Permalink
Update README.org with existing functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
LA-Toth committed Dec 11, 2023
1 parent 57168c8 commit ba04bc7
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand All @@ -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)
Expand Down

0 comments on commit ba04bc7

Please sign in to comment.