org roam
v2.2.2
Org-ROAM est un système de gestion des connaissances en texte clair. Il apporte certaines des fonctionnalités les plus puissantes de Roam dans l'écosystème du mode org.
Org-ROAM emprunte les principes de la méthode Zettelkasten, fournissant une solution pour la prise de notes non hiérarchique. Cela devrait également fonctionner comme une solution de plug-and-play pour quiconque utilise déjà le mode org pour son wiki personnel.
Ci-dessous, vous trouverez des instructions d'installation de base pour installer rapidement org-roam en utilisant divers environnements à diverses fins. Pour des informations plus détaillées, veuillez lire le manuel.
package.el Vous pouvez installer org-roam à partir de Melpa ou Melpa Stable à l'aide package.el :
M-x package-install RET org-roam RET
straight.el Installation de Melpa ou Melpa stable à l'aide de straight.el :
( straight-use-package 'org-roam ) Ou avec use-package :
( use-package org-roam
:straight t
...)Si vous devez installer le package directement à partir du référentiel source, au lieu de Melpa, l'échantillon suivant montre comment le faire:
( use-package org-roam
:straight ( :host github :repo " org-roam/org-roam "
:files ( :defaults " extensions/* " ))
...)Si vous prévoyez d'utiliser votre propre fourche locale pour le développement et la contribution, l'échantillon suivant vous y mènera:
( use-package org-roam
:straight ( :local-repo " /path/to/org-roam-fork "
:files ( :defaults " extensions/* " )
:build ( :not compile))
...) Le module DOOM :lang org est livré avec la prise en charge d' org-roam , mais il n'est pas activé par défaut. Pour l'activer passe +roam2 Indicateur vers org dans votre $DOOMDIR/init.el (par exemple (org +roam2) ), enregistrez le fichier et exécutez doom sync -u dans votre shell.
Pour offrir une meilleure stabilité, Doom épingle le package à un engagement spécifique. Si vous avez besoin de le défaire (non recommandé de le faire, demandez à Doom de bousculer le package à la place), utilisez le suivant dans vos packages.el :
(unpin! org-roam) Si pour certaines raisons, vous souhaitez utiliser une recette différente pour org-roam , vous pouvez utiliser le formulaire suivant dans vos packages.el pour installer le package à partir d'un référentiel de recettes (par exemple Melpa):
(package! org-roam) Vous pouvez passer :pin "commit hash" pour épingler le package à un engagement spécifique.
Avec l'échantillon suivant, vous pouvez installer le package directement à partir du référentiel source:
(package! org-roam
:recipe ( :host github :repo " org-roam/org-roam "
:files ( :defaults " extensions/* " )))Et si vous prévoyez d'utiliser votre propre fourche locale pour le développement ou la contribution, l'échantillon suivant vous y mènera:
(package! org-roam
:recipe ( :local-repo " /path/to/org-roam-fork "
:files ( :defaults " extensions/* " )
:build ( :not compile)))Pour installer le package sans utiliser de gestionnaire de packages, vous avez les deux options suivantes:
git à partir du référentiel source.Dans les deux cas, vous devrez vous assurer que vous avez toutes les dépendances requises. Ceux-ci incluent:
Après avoir installé le package, vous devrez configurer correctement load-path dans le package:
( add-to-list 'load-path " /path/to/org-roam/ " )
( add-to-list 'load-path " /path/to-org-roam/extensions/ " ) Après quoi vous devriez être en mesure de résoudre (require 'org-roam) appel sans aucun problème.
Org-ROAM est également livré avec des fichiers .texi pour s'intégrer au système d'information intégré d'EMACS. Lisez le manuel pour trouver plus de détails pour les installer manuellement.
Voici un échantillon très basique pour la configuration d' org-roam à l'aide d' 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 )) Notez que la fonction file-truename n'est nécessaire que lorsque vous utilisez un lien symbolique vers org-roam-directory . Org-ROAM ne résoudra pas automatiquement le lien symbolique vers le répertoire.
David Wilson de System Crafters a produit une vidéo d'introduction qui couvre les commandes de base:
Avant de créer un nouveau sujet / problème, veuillez être attentif à notre temps et vous assurer qu'il n'a pas déjà été abordé sur Github ou sur le discours.
Pour signaler les bogues et suggérer de nouvelles fonctionnalités, utilisez le tracker du problème. Si vous avez du code que vous souhaitez fusionner, ouvrez une demande de traction. Veuillez également consulter la contribution.md.
Copyright © Jethro Kuan et contributeurs. Distribué sous la licence publique générale GNU, version 3.
