org roam

Org-roam

ORG-Roam ist ein System-Text-Wissensmanagementsystem. Es bringt einige der stärkeren Merkmale von Roam in das Org-Mode-Ökosystem.

Org-Roam lehnt Prinzipien aus der Zettelkasten-Methode aus und liefert eine Lösung für nicht-hierarchische Notizen. Es sollte auch als Plug-and-Play-Lösung für alle funktionieren, die bereits Org-Mode für ihr persönliches Wiki verwenden.

• Privat und sicher : Bearbeiten Sie Ihr persönliches Wiki vollständig offline, ganz in Ihrer Kontrolle. Verschlüsseln Sie Ihre Notizen mit GPG. Machen Sie sich dauerhafte Notizen in einfacher Text.
• Netzwerk Gedanken : Verbinden Sie Notizen und Gedanken mit Leichtigkeit mit Backlinks. Entdecken Sie überraschende und bisher unsichtbare Verbindungen in Ihren Notizen mit der integrierten Graph-Visualisierung.
• Erweiterbar und leistungsstark : Nutzen Sie die fantastische textbearbeitete Schnittstelle von EMACS und das reifen EMACS- und Org-Mode-Ökosystem von Paketen.
• Frei und Open Source : Org-Roam ist unter der GNU General Public Lizenz Version 3 oder höher lizenziert.

• Dokumentation
• Diskurs
• Locker
• Häufig gestellte Fragen
• Changelog

Installation

Im Folgenden finden Sie grundlegende Installationsanweisungen, wie Sie org-roam schnell mit verschiedenen Umgebungen für verschiedene Zwecke installieren können. Für detailliertere Informationen lesen Sie bitte das Handbuch.

Mit package.el

Anweisungen umschalten

Sie können org-roam von melpa oder melpa stabil mit package.el installieren:

 M-x package-install RET org-roam RET

Mit straight.el

Anweisungen umschalten

Installation von melpa oder melpa stabil mit straight.el :

( straight-use-package 'org-roam )

Oder mit use-package :

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

Wenn Sie das Paket direkt aus dem Quell -Repository anstelle von melpa installieren müssen, zeigt das nächste Beispiel, wie dies zu tun ist:

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

Wenn Sie vorhaben, Ihre eigene lokale Gabel für die Entwicklung und den Beitrag zu verwenden, bringt Sie mit der nächsten Stichprobe dorthin:

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

Verwenden von Doom -EMACs

Anweisungen umschalten

Doom's :lang org Modul wird mit Unterstützung für org-roam unterstützt, ist jedoch standardmäßig nicht aktiviert. Um es in Ihrem $DOOMDIR/init.el (z. B. (org +roam2) ) zu aktivieren, um das +roam2 -Flag zum org -Modul zu aktivieren, speichern Sie die Datei und führen Sie doom sync -u in Ihrer Shell aus.

Um eine bessere Stabilität zu gewährleisten, steigt das Paket an ein bestimmtes Commit ein. Wenn Sie es entfalten müssen (nicht empfohlen werden, fordern Sie das Paket an, das Paket zu stoßen). Verwenden Sie die nächste in Ihren packages.el :

(unpin! org-roam)

Wenn Sie aus einigen Gründen ein anderes Rezept für org-roam verwenden möchten, können Sie das nächste Formular in Ihren packages.el verwenden.

(package! org-roam)

Sie können übergeben :pin "commit hash" , um das Paket an ein bestimmtes Commit festzuhalten.

Mit dem nächsten Beispiel können Sie das Paket direkt über das Quell -Repository installieren:

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

Und wenn Sie planen, Ihre eigene lokale Gabel für die Entwicklung oder den Beitrag zu verwenden, bringt Sie mit der nächsten Stichprobe dorthin:

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

Ohne Paketmanager

Anweisungen umschalten

So installieren Sie das Paket, ohne einen Paketmanager zu verwenden, Sie haben die nächsten beiden Optionen:

1. Installieren Sie das Paket, indem Sie es mit git aus dem Quell -Repository klonen.
2. Oder installieren Sie das Paket, indem Sie die neueste Versionsversion herunterladen.

In beiden Fällen müssen Sie sicherstellen, dass Sie über alle erforderlichen Abhängigkeiten verfügen. Dazu gehören:

• Bindestrich
• F
• S
• org (9.4 ist die minimal erforderliche Version!)
• EMACSQL
• EMACSQL-SQLITE
• Magit-Abschnitt
• FileNotify-recursive

Nach dem Installieren des Pakets müssen Sie load-path auf das Paket ordnungsgemäß einstellen:

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

Danach sollten Sie in der Lage sein, ohne Probleme aufzulösen (require 'org-roam) aufzurufen.

Org-Roam wird auch mit .texi Dateien geliefert, um das integrierte Info-System von EMACS zu integrieren. Lesen Sie das Handbuch, um weitere Details zu finden, um sie manuell zu installieren.

Konfiguration

Hier ist ein sehr einfaches Beispiel für die Konfiguration von org-roam mit Verwendung von 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 ))

Beachten Sie, dass die Funktion file-truename nur dann erforderlich ist, wenn Sie einen symbolischen Link zum org-roam-directory verwenden. Org-Roam wird den symbolischen Link zum Verzeichnis nicht automatisch auflösen.

Erste Schritte

David Wilson von System Crafters hat ein Einführungsvideo erstellt, das die grundlegenden Befehle abdeckt:

Hilfe bekommen

Bevor Sie ein neues Thema/ein neues Thema erstellen, achten Sie auf unsere Zeit und stellen Sie sicher, dass es noch nicht auf Github oder Diskurs behandelt wurde.

• Wenn Sie neu in EMACs sind und Probleme mit dem Einrichten von ORG-Roam haben, stellen Sie bitte Ihre Frage zu Slack, Channel #How-Do-I.
• Für kurze Fragen stellen Sie sie bitte auf Slack, Channel #RoUbleshooting.
• Wenn etwas nicht so funktioniert, wie es sollte, oder wenn Sie eine neue Funktion vorschlagen möchten, erstellen Sie bitte ein neues Problem.
• Wenn Sie Fragen zu Ihrem Workflow mit der Slip-Box-Methode haben, finden Sie ein relevantes Thema zum Diskurs oder erstellen Sie eine neue.

Wissensbasis mit org-Roam

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

Beitragen

Um Fehler zu melden und neue Funktionen vorzuschlagen, verwenden Sie den Issue Tracker. Wenn Sie einen Code haben, den Sie zusammengeführt werden möchten, öffnen Sie eine Pull -Anfrage. Bitte sehen Sie auch einen Beitrag.md.

Lizenz

Copyright © Jethro Kuan und Mitwirkende. Verteilt unter der GNU General Public Lizenz, Version 3.