org roam
v2.2.2
Org-Roam-это просто текстовая система управления знаниями. Это привносит некоторые из более мощных функций Роума в экосистему Org-Mode.
Орг-Руам заимствует принципы из метода Zettelkasten, предоставляя решение для неиерархического принятия нот. Он также должен работать в качестве решения для подключения и игры для тех, кто уже использует Org-Mode для их личного вики.
Внизу вы найдете основные инструкции по установке для быстрого установки org-roam используя различные среды для различных целей. Для получения более подробной информации, пожалуйста, прочитайте руководство.
package.el Вы можете установить org-roam из Melpa или Melpa Stable с помощью 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 Module поставляется с поддержкой org-roam , но он не включен по умолчанию. Чтобы активировать его проход +roam2 флаг в модуль org в вашем $DOOMDIR/init.el (например (org +roam2) ), сохраните файл и запустите doom sync -u в вашей оболочке.
Чтобы обеспечить лучшую стабильность, Doom прикрепляет пакет к конкретному коммитию. Если вам нужно отписать это (не рекомендуется сделать это, запросите Doom вместо этого ударить пакет), используйте следующий в ваших packages.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. Прочитайте руководство, чтобы найти более подробную информацию о том, как установить их вручную.
Вот очень простой образец для конфигурации 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 . Орг-Руам не будет автоматически разрешить символическую ссылку на каталог.
Дэвид Уилсон из System Crafters создал вводное видео, которое охватывает основные команды:
Прежде чем создавать новую тему/проблему, пожалуйста, помните о наше время и убедитесь, что она еще не была рассмотрена на GitHub или в дискурсе.
Чтобы сообщить об ошибках и предложить новую функцию, используйте трекер выпуска. Если у вас есть какой -то код, который вы хотели бы быть объединенным, откройте запрос на тягу. Пожалуйста, также см. Appling.md.
Copyright © Jethro Kuan и участники. Распространено по общедоступной лицензии GNU, версия 3.
