awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-01 12:17:21 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
791c0592007bed05a0bd952c0326b51f9c6ad5bc
org-roam/doc/installation.md
Jethro Kuan 791c059200 Simplify org-roam-insert and org-roam-find-file (#62) 
* Simplify org-roam-insert and org-roam-find-file

See #59.

* Add docs for org-roam automatic filenaming

* Update installation instructions
2020-02-13 00:25:45 +08:00

1.0 KiB
Raw Blame History

Installation

The recommended method is using use-package and straight, or a similar package manager.

(use-package org-roam
      :after org
      :hook (org-mode . org-roam-mode)
      :straight (:host github :repo "jethrokuan/org-roam")
      :custom
      (org-roam-directory "/path/to/org-files/")
      :bind
      ("C-c n l" . org-roam)      
      ("C-c n t" . org-roam-today)
      ("C-c n f" . org-roam-find-file)
      ("C-c n i" . org-roam-insert)
      ("C-c n g" . org-roam-show-graph))

If not using package.el, you can also clone it into your Emacs directory and add it to your load path:

git clone https://github.com/jethrokuan/org-roam/ ~/.emacs.d/elisp/org-roam

(add-to-list 'load-path "./elisp")
(require 'org-roam)

There are a number of important configuration options, that greatly affect the Roam workflow. Do look through them at the Configuration page.