org roam

org-roam

Org-Roam是一种普通文本知识管理系统。它将漫游的一些更强大的功能带入了组织模式生态系统中。

Org-Roam从Zettelkasten方法借用原则，为非等级笔记提供解决方案。它还应该用作插件解决方案，适用于已经使用org-mode进行个人Wiki的任何人。

• 私人和安全：完全在您的控制中，完全离线编辑您的个人Wiki。用GPG加密笔记。在纯文本中持续笔记。
• 网络思想：使用反向链接轻松地连接笔记和思想。通过内置图可视化发现笔记中的令人惊讶和以前看不见的连接。
• 可扩展和强大的：利用Emacs出色的文本编辑界面，以及包装的成熟emacs和Org模式生态系统。
• 免费和开源：Org-Roam获得了GNU通用公共许可证版本3或更高版本的许可。

• 文档
• 话语
• 松弛
• 常见问题
• ChangElog

安装

在下面，您将找到如何使用各种环境来快速安装org-roam基本安装说明。有关更多详细信息，请阅读手册。

使用package.el

切换说明

您可以使用package.el安装MELPA或MELPA稳定的org-roam ：

 M-x package-install RET org-roam RET

使用straight.el

切换说明

使用straight.el从MELPA或MELPA稳定的安装：

( 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 emacs

切换说明

Doom's :lang org模块具有对org-roam的支持，但默认情况下不启用它。要激活其将+roam2标志传递到您的$DOOMDIR/init.el （例如(org +roam2) ）中的org模块，请保存文件并在您的外壳中运行doom sync -u 。

为了提供更好的稳定性，请注定包裹将包裹固定到特定的提交中。如果您需要取消启动（不建议这样做，请要求doom撞到包裹），请使用packages.el中的下一个：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)))

没有包装管理器

切换说明

要安装软件包而无需使用软件包管理器，您有接下来的两个选项：

1. 通过将其从源存储库中的git克隆来安装软件包。
2. 或通过下载最新版本版本安装软件包。

在这两种情况下，您都需要确保拥有所有必需的依赖项。其中包括：

• 短跑
• f
• s
• org（9.4是最小必需的版本！）
• emacsql
• emacsql-sqlite
• 玛格特部分
• fileNotify恢复

安装软件包后，您将需要正确设置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的内置信息系统集成。阅读手册以查找有关如何手动安装它们的更多详细信息。

配置

这是使用use-package配置org-roam的非常基本的示例：

( 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 ))

请注意，仅当您使用符号链接到org-roam-directory时，该file-truename函数才有必要。 Org-Roam不会自动解析到目录的符号链接。

入门

System Crafters的David Wilson制作了一个介绍视频，涵盖了基本命令：

得到帮助

在创建一个新主题/问题之前，请注意我们的时间，并确保尚未在Github或话语上解决它。

• 如果您是emacs的新手，并且设置了org-roam问题，请在Slack，cannel＃whowdo-i上询问您的问题。
• 有关快速问题，请在Slack，#Troubleshooting上询问他们。
• 如果某事无法正常工作，或者您想建议一项新功能，请创建一个新问题。
• 如果您使用Slip-Box方法对工作流有疑问，请找到有关话语的相关主题，或创建一个新的主题。

知识库使用org-roam

• Jethro Kuan（来源）
• Alexey Shmalko
• Sidharth Arya
• 马丁·埃德斯特斯

贡献

报告错误并建议新功能使用问题跟踪器。如果您有一些要合并的代码，请打开拉动请求。请参阅贡献。

执照

版权所有©Jethro Kuan和贡献者。根据GNU通用公共许可证（版本3）分发。