Org-Roam เป็นระบบการจัดการความรู้ข้อความธรรมดา มันนำคุณสมบัติที่ทรงพลังกว่าของ Roam มาสู่ระบบนิเวศโหมด Org
Org-Roam ยืมหลักการจากวิธี Zettelkasten ซึ่งเป็นวิธีการแก้ปัญหาสำหรับการจดบันทึกที่ไม่ใช่ลำดับชั้น นอกจากนี้ยังควรทำงานเป็นโซลูชันแบบปลั๊กแอนด์เพลย์สำหรับทุกคนที่ใช้โหมด org สำหรับวิกิส่วนตัวของพวกเขา
ด้านล่างคุณจะพบคำแนะนำการติดตั้งขั้นพื้นฐานสำหรับวิธีการติดตั้ง org-roam อย่างรวดเร็วโดยใช้สภาพแวดล้อมที่หลากหลายเพื่อวัตถุประสงค์ต่าง ๆ สำหรับข้อมูลรายละเอียดเพิ่มเติมโปรดอ่านคู่มือ
package.el คุณสามารถติดตั้ง org-roam จาก melpa หรือ melpa เสถียรโดยใช้ package.el :
M-x package-install RET org-roam RET
straight.el การติดตั้งจาก Melpa หรือ Melpa เสถียรโดยใช้ straight.el :
( 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 FLAG ไปยังโมดูล org ใน $DOOMDIR/init.el (เช่น (org +roam2) ) บันทึกไฟล์และเรียกใช้ doom sync -u ในเชลล์ของคุณ
เพื่อให้มีเสถียรภาพที่ดีขึ้น DOOM จะจัดแพ็คเกจให้กับการกระทำที่เฉพาะเจาะจง หากคุณต้องการที่จะปลดปล่อยมัน (ไม่แนะนำให้ทำเช่นนั้นขอให้ Doom ชนแพ็คเกจแทน) ใช้สิ่งต่อไปใน packages.el ของคุณ
(unpin! org-roam) หากด้วยเหตุผลบางอย่างที่คุณต้องการใช้สูตรอื่นสำหรับ org-roam คุณสามารถใช้แบบฟอร์มถัดไปใน packages.el ของคุณ. 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 อ่านคู่มือเพื่อค้นหารายละเอียดเพิ่มเติมเกี่ยวกับวิธีการติดตั้งด้วยตนเอง
นี่คือตัวอย่างพื้นฐานมากสำหรับการกำหนดค่า org-roam โดยใช้ use-package :
( 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 )) โปรดทราบว่าฟังก์ชั่น file-truename มีความจำเป็นเฉพาะเมื่อคุณใช้ลิงก์สัญลักษณ์ไปยัง org-roam-directory Org-Roam จะไม่สามารถแก้ไขลิงก์สัญลักษณ์ไปยังไดเรกทอรีได้โดยอัตโนมัติ
David Wilson of System Crafters ได้ผลิตวิดีโอเบื้องต้นที่ครอบคลุมคำสั่งพื้นฐาน:
ก่อนที่จะสร้างหัวข้อ/ปัญหาใหม่โปรดระวังเวลาของเราและตรวจสอบให้แน่ใจว่ายังไม่ได้รับการแก้ไขใน GitHub หรือวาทกรรม
ในการรายงานข้อบกพร่องและแนะนำคุณสมบัติใหม่ให้ใช้ตัวติดตามปัญหา หากคุณมีรหัสบางอย่างที่คุณต้องการรวมเข้าด้วยกันให้เปิดคำขอดึง โปรดดูการสนับสนุน
ลิขสิทธิ์© Jethro Kuan และผู้สนับสนุน แจกจ่ายภายใต้ใบอนุญาตสาธารณะ GNU ทั่วไปเวอร์ชัน 3