Org-Roam是一種普通文本知識管理系統。它將漫遊的一些更強大的功能帶入了組織模式生態系統。
Org-Roam從Zettelkasten方法借用原則,為非等級筆記提供解決方案。它還應該用作插件解決方案,適用於已經使用org-mode進行個人Wiki的任何人。
在下面,您將找到如何使用各種環境來快速安裝org-roam基本安裝說明。有關更多詳細信息,請閱讀手冊。
package.el您可以使用package.el安裝MELPA或MELPA穩定的org-roam :
M-x package-install RET org-roam RET
straight.el使用straight.el從MELPA或MELPA穩定的安裝:
( straight-use-package 'org-roam )或使用use-package :
( use-package org-roam
:straight t
...)如果您需要直接從源存儲庫中安裝軟件包,而不是從MELPA中安裝,則下一個示例顯示瞭如何做到:
( use-package org-roam
:straight ( :host github :repo " org-roam/org-roam "
:files ( :defaults " extensions/* " ))
...)如果您打算使用自己的本地叉子進行開發和貢獻,那麼下一個樣本將使您到達那裡:
( use-package org-roam
:straight ( :local-repo " /path/to/org-roam-fork "
:files ( :defaults " extensions/* " )
:build ( :not compile))
...)Doom's :lang org模塊具有對org-roam的支持,但默認情況下不啟用它。要激活其將+roam2標誌傳遞到您的$DOOMDIR/init.el (例如(org +roam2) )中的org模塊,請保存文件並在您的外殼中運行doom sync -u 。
為了提供更好的穩定性,請注定包裹將包裹固定到特定的提交中。如果您需要取消啟動(不建議這樣做,請要求doom撞到包裹),請使用packages.el中的下一個:el:
(unpin! org-roam)如果出於某些原因要使用org-roam的其他食譜,則可以使用packages.el中的下一個表單來安裝食譜存儲庫(例如melpa):
(package! org-roam)您可以通過:pin "commit hash"將包裝固定在特定的提交中。
使用下一個示例,您可以直接從源存儲庫中安裝軟件包:
(package! org-roam
:recipe ( :host github :repo " org-roam/org-roam "
:files ( :defaults " extensions/* " )))而且,如果您打算使用自己的本地叉子進行開發或貢獻,那麼下一個樣本將使您到達那裡:
(package! org-roam
:recipe ( :local-repo " /path/to/org-roam-fork "
:files ( :defaults " extensions/* " )
:build ( :not compile)))要安裝軟件包而無需使用軟件包管理器,您有接下來的兩個選項:
git克隆來安裝軟件包。在這兩種情況下,您都需要確保擁有所有必需的依賴項。其中包括:
安裝軟件包後,您將需要正確設置load-path到包:
( add-to-list 'load-path " /path/to/org-roam/ " )
( add-to-list 'load-path " /path/to-org-roam/extensions/ " )之後,您應該能夠解決(require 'org-roam)無問題。
org-roam還附帶了.texi文件,以與Emacs的內置信息系統集成。閱讀手冊以查找有關如何手動安裝它們的更多詳細信息。
這是使用use-package配置org-roam的非常基本的示例:
( use-package org-roam
:ensure t
:custom
(org-roam-directory ( file-truename " /path/to/org-files/ " ))
:bind (( " C-c n l " . org-roam-buffer-toggle)
( " C-c n f " . org-roam-node-find)
( " C-c n g " . org-roam-graph)
( " C-c n i " . org-roam-node-insert)
( " C-c n c " . org-roam-capture)
; ; Dailies
( " C-c n j " . org-roam-dailies-capture-today))
:config
; ; If you're using a vertical completion framework, you might want a more informative completion interface
( setq org-roam-node-display-template ( concat " ${title:*} " ( propertize " ${tags:10} " 'face 'org-tag )))
(org-roam-db-autosync-mode)
; ; If using org-roam-protocol
( require 'org-roam-protocol ))請注意,僅當您使用符號鏈接到org-roam-directory時,該file-truename函數才有必要。 Org-Roam不會自動解析到目錄的符號鏈接。
System Crafters的David Wilson製作了一個介紹視頻,涵蓋了基本命令:
在創建一個新主題/問題之前,請注意我們的時間,並確保尚未在Github或話語上解決它。
報告錯誤並建議新功能使用問題跟踪器。如果您有一些要合併的代碼,請打開拉動請求。請參閱貢獻。
版權所有©Jethro Kuan和貢獻者。根據GNU通用公共許可證(版本3)分發。