Org-roam-UI – 用于探索您的 org-roam Zettelkasten 的图形前端

2021-08-01 21:04:10

Org-Roam-UI 是 org-roam-server 的后继者,它通过与 Emacs 并行运行的 Web 应用程序扩展了 org-roam 的功能。如果您的 Emacs 缺少任何依赖项,请手动安装它们!org-roam-ui 需要 org-roam、websocket、simple-httpd、f 和 Emacs >27 以进行快速 JSON 解析。 (use-package! websocket :after org-roam)(use-package! org-roam-ui :after org-roam ;; 或 :after org :hook (org-roam . org-roam-ui-mode) :config ) 我们建议只在加载 org(-roam) 之后加载 org-roam-ui,因为启动服务器和发出数据库请求会极大地影响启动时间。 ( use-package org-roam-ui :straight ( :host github :repo "org-roam/org-roam-ui " :branch "main " :files ( "*.el " "out ")) :after org- roam :hook (org-roam . org-roam-ui-mode)) 使用 Mx org-roam-ui-mode RET 启用全局模式。它将在 http://127.0.0.1:35901/ 上启动一个 web 服务器并通过 WebSocket 连接到它以进行实时更新。 ORUI 提供了一些无需离开 Emacs 即可与图形交互的命令。注意:目前这很笨拙,将来会改变。把这更像是一个预告片。

以毫秒为单位的缩放速度(可以在 UI 中设置)。这些选项目前可能不起作用,请暂时在 UI 中配置它们。 Org-Roam-UI 公开了一些变量,但大部分定制是在 Web 应用程序中完成的。我们计划使图的更新顺利进行,目前只有在更新发生时才能重新加载整个图(但保留本地模式)。这是默认启用的,禁用 Org-Roam-UI 可以同步您的 Emacs 主题!这是默认行为,禁用它如果您不喜欢同步也不喜欢默认主题,您也可以提供自己的主题。为此,请将 org-roam-ui-custom-theme 设置为(相当具体的)变量列表,例如 ( setq org-roam-ui-custom-theme ( list (bg . '#1E2029') (bg- alt . '#282a36') (fg . '#f8f8f2') (fg-alt . '#6272a4') (red . '#ff5555') (orange . '#f1fa8c') (yellow .'#ffb86c') (绿色。'#50fa7b') (青色。'#8be9fd') (蓝色。'#ff79c6') (紫色。'#8be9fd') (品红色。'#bd93f9')))

您可以选择在最后一个之后提供 (base1 . '#XXXXXX') 参数来设置背景阴影,否则 ORUI 将根据提供的 bg 和 fg 进行猜测。顾名思义,Org-Roam-UI 仅适用于 org-roam!如果您以其他形式组织笔记 org-roam-ui 无法工作,因为它使用 org-roam 来获取所有连接。与 org-roam-server 的功能对等不是目标。虽然我们的目标是制作一个类似的产品,它具有可视化图表来帮助您探索和导航您的 org-roam 节点,但我们不打算复制所有这些,也不限于复制 org-roam-server 的功能。这是 alpha 软件:请尝试使用它,但期待错误和故障排除!该项目是由几个修补匠创建的,目的是为了解决他们自己的问题。我们不会得到任何物质方面的回报,发展可能会在任何一天停止(因为生活)。让项目保持活力的最好方法是探索代码并做出贡献!虽然我们尝试优化图形的显示,但我们能做的只有这么多。对于大型网络(> 2k 节点),大量拖动图形可能会导致一些性能问题,但您可以采取一些措施来加快速度。尽管让我们感到难过,但 Firefox 的渲染引擎比它的 Chromium 表亲要慢得多。比较两者的性能,看看这是否是主要问题。

我知道,看到那些小家伙在你的笔记上下移动非常酷,但速度很慢,尤其是在 3D 模式下。可能是渲染第二慢的东西,几乎不可能加快它的速度。考虑仅在突出显示时打开标签或调高“标签外观比例”。不错,就是贵!如果你想让图形更分散,关闭碰撞对结果布局的影响很小,但会大大提高性能。根据我们的经验,一旦图形真正稳定下来并且不需要再次渲染,环顾四周应该不会有什么问题。目前没有办法“保存”图形配置,但我们正在探索这种可能性。然而,图形布局算法是确定性的,因此除非对数据进行任何更改,否则每次都应该产生相同的结果。目前我们还没有显示使用 org-roam-bibtex 制作的引文链接,但我们很快就会!希望,是的!但是时间是有限的,所以我们可以在它自己内爆之前塞进这些东西的功能数量是有限的,所以我们正在逐步添加东西以确保它们工作。也就是说,我们很乐意听取您的意见!请在此讨论中发布功能请求或为已经发布的功能点赞,这样我们就可以稍微调整我们的优先级! Org-Roam-UI 的主要功能是能够生成您的 org-roam 笔记的图形可视化。

(双击)点击一个节点会在 Emacs 中打开相应的笔记,非常酷。你不需要 org-protocol,它开箱即用!当你在 Emacs 中打开一个笔记时,org-roam-ui 会移动到图上对应的节点。