org roam

Org-roam

Org-Roam adalah sistem manajemen pengetahuan teks sederhana. Ini membawa beberapa fitur Roam yang lebih kuat ke dalam ekosistem mode org.

Org-Roam meminjam prinsip-prinsip dari metode Zettelkasten, memberikan solusi untuk pencatatan non-hierarkis. Ini juga harus berfungsi sebagai solusi plug-and-play untuk siapa saja yang sudah menggunakan mode org untuk wiki pribadi mereka.

• Pribadi dan Aman : Edit wiki pribadi Anda sepenuhnya offline, sepenuhnya dalam kendali Anda. Enkripsi catatan Anda dengan GPG. Buat catatan abadi dalam teks biasa.
• Networked Thoughts : Connect Notes dan Pikiran Bersama dengan mudah menggunakan backlink. Temukan koneksi yang mengejutkan dan sebelumnya tidak terlihat dalam catatan Anda dengan visualisasi grafik bawaan.
• Extensible and Powerful : Leverage EMACs 'antarmuka pengeditan teks yang fantastis, dan Emacs dewasa dan ekosistem paket mode org.
• GRATIS dan Open Source : Org-Roam dilisensikan di bawah GNU Umum Lisensi Publik Versi 3 atau lebih baru.

• Dokumentasi
• Ceramah
• Kendur
• Pertanyaan yang sering diajukan
• Changelog

Instalasi

Di bawah Anda akan menemukan instruksi pemasangan dasar untuk cara menginstal org-roam dengan cepat menggunakan berbagai lingkungan untuk berbagai tujuan. Untuk informasi lebih rinci, silakan baca manualnya.

Menggunakan package.el

Pengalihan instruksi

Anda dapat menginstal org-roam dari Melpa atau Melpa Stable menggunakan package.el :

 M-x package-install RET org-roam RET

Menggunakan straight.el

Pengalihan instruksi

Instalasi dari Melpa atau Melpa Stable menggunakan straight.el :

( straight-use-package 'org-roam )

Atau dengan use-package :

( use-package org-roam
  :straight t
  ...)

Jika Anda perlu menginstal paket langsung dari repositori sumber, alih -alih dari Melpa, sampel berikutnya menunjukkan cara melakukannya:

( use-package org-roam
  :straight ( :host github :repo " org-roam/org-roam "
             :files ( :defaults " extensions/* " ))
  ...)

Jika Anda berencana untuk menggunakan garpu lokal Anda sendiri untuk pengembangan dan kontribusi, sampel berikutnya akan membawa Anda ke sana:

( use-package org-roam
  :straight ( :local-repo " /path/to/org-roam-fork "
             :files ( :defaults " extensions/* " )
             :build ( :not compile))
  ...)

Menggunakan Doom Emacs

Pengalihan instruksi

Doom's :lang org hadir dengan dukungan untuk org-roam , tetapi tidak diaktifkan secara default. Untuk mengaktifkannya lulus +roam2 ke modul org di $DOOMDIR/init.el Anda (misalnya (org +roam2) ), simpan file dan jalankan doom sync -u di shell Anda.

Untuk memberikan stabilitas yang lebih baik, pin malapetaka paket ke komit tertentu. Jika Anda perlu membatalkannya (tidak disarankan untuk melakukan itu, minta malapetaka untuk menabrak paket sebagai gantinya) Gunakan yang berikutnya dalam packages.el Anda.

(unpin! org-roam)

Jika karena beberapa alasan Anda ingin menggunakan resep yang berbeda untuk org-roam , Anda dapat menggunakan formulir berikutnya dalam packages.el Anda.

(package! org-roam)

Anda dapat lulus :pin "commit hash" untuk menyematkan paket ke komit tertentu.

Dengan sampel berikutnya Anda dapat menginstal paket langsung dari repositori sumber:

(package! org-roam
  :recipe ( :host github :repo " org-roam/org-roam "
           :files ( :defaults " extensions/* " )))

Dan jika Anda berencana untuk menggunakan garpu lokal Anda sendiri untuk pengembangan atau kontribusi, sampel berikutnya akan membawa Anda ke sana:

(package! org-roam
  :recipe ( :local-repo " /path/to/org-roam-fork "
           :files ( :defaults " extensions/* " )
           :build ( :not compile)))

Tanpa manajer paket

Pengalihan instruksi

Untuk menginstal paket tanpa menggunakan manajer paket, Anda memiliki dua opsi berikutnya:

1. Instal paket dengan mengkloningnya dengan git dari repositori sumber.
2. Atau instal paket dengan mengunduh versi rilis terbaru.

Dalam kedua kasus, Anda perlu memastikan bahwa Anda memiliki semua dependensi yang diperlukan. Ini termasuk:

• dasbor
• F
• S
• org (9.4 adalah versi minimal yang dibutuhkan!)
• Emacsql
• Emacsql-sqlite
• bagian magit
• FileNotify-Recursive

Setelah menginstal paket, Anda harus mengatur load-path dengan benar ke paket:

( add-to-list 'load-path " /path/to/org-roam/ " )
( add-to-list 'load-path " /path/to-org-roam/extensions/ " )

Setelah itu Anda harus dapat menyelesaikan (require 'org-roam) panggilan tanpa masalah.

Org-Roam juga dilengkapi dengan file .texi untuk diintegrasikan dengan sistem info bawaan Emacs. Baca manual untuk menemukan detail lebih lanjut tentang cara menginstalnya secara manual.

Konfigurasi

Berikut sampel yang sangat mendasar untuk konfigurasi org-roam menggunakan 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 ))

Perhatikan bahwa fungsi file-truename hanya diperlukan saat Anda menggunakan tautan simbolik ke org-roam-directory . Org-Roam tidak akan secara otomatis menyelesaikan tautan simbolik ke direktori.

Memulai

David Wilson dari System Crafters telah menghasilkan video pengantar yang mencakup perintah dasar:

Mendapatkan bantuan

Sebelum membuat topik/masalah baru, harap perhatikan waktu kita dan pastikan bahwa itu belum dibahas di Github atau wacana.

• Jika Anda baru mengenal Emacs dan memiliki masalah pengaturan org-roam, silakan ajukan pertanyaan Anda di Slack, saluran #how-do-i.
• Untuk pertanyaan cepat, silakan tanyakan pada mereka di Slack, saluran #Troubleshooting.
• Jika ada sesuatu yang tidak berfungsi sebagaimana mestinya, atau jika Anda ingin menyarankan fitur baru, silakan buat masalah baru.
• Jika Anda memiliki pertanyaan tentang alur kerja Anda dengan metode slip-box, silakan temukan topik yang relevan tentang wacana, atau buat yang baru.

Basis pengetahuan menggunakan org-roam

• Jethro Kuan (Sumber)
• Alexey Shmalko
• Sidharth Arya
• Martin Edström

Berkontribusi

Untuk melaporkan bug dan menyarankan fitur baru, gunakan pelacak masalah. Jika Anda memiliki beberapa kode yang ingin Anda gabungkan, maka buka permintaan tarik. Silakan juga lihat Contributing.md.

Lisensi

Hak Cipta © Jethro Kuan dan Kontributor. Didistribusikan di bawah Lisensi Publik Umum GNU, versi 3.