bhipple/org-roam

Rudimentary Roam replica with Org-mode

Org-roam

Org-roam is a plain-text knowledge management system. It brings some of Roam's more powerful features into the Org-mode ecosystem.

Org-roam borrows principles from the Zettelkasten method, providing a solution for non-hierarchical note-taking. It should also work as a plug-and-play solution for anyone already using Org-mode for their personal wiki.

• Private and Secure: Edit your personal wiki completely offline, entirely in your control. Encrypt your notes with GPG. Take lasting notes in plain-text.
• Networked Thought: Connect notes and thoughts together with ease using backlinks. Discover surprising and previously unseen connections in your notes with the built-in graph visualization.
• Extensible and Powerful: Leverage Emacs' fantastic text-editing interface, and the mature Emacs and Org-mode ecosystem of packages.
• Free and Open Source: Org-roam is licensed under the GNU General Public License version 3 or later.

• Documentation
• Discourse
• Slack
• Frequently Asked Questions
• Changelog

Installation

You can install org-roam using package.el:

M-x package-install RET org-roam RET

Here's a sample configuration with 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
      (org-roam-setup)
      ;; If using org-roam-protocol
      (require 'org-roam-protocol))

The file-truename function is only necessary when you use symbolic links inside org-roam-directory: Org-roam does not resolve symbolic links.

Org-roam requires sqlite to function. Org-roam optionally uses Graphviz for graph-related functionality. It is recommended to install PCRE-enabled ripgrep for better performance and extended functionality.

Getting Started

David Wilson of System Crafters has produced an introductory video that covers the basic commands:

Getting Help

Before creating a new topic/issue, please be mindful of our time and ensure that it has not already been addressed on GitHub or on Discourse.

• If you are new to Emacs and have problem setting up Org-roam, please ask your question on Slack, channel #how-do-i.
• For quick questions, please ask them on Slack, channel #troubleshooting.
• If something is not working as it should, or if you would like to suggest a new feature, please create a new issue.
• If you have questions about your workflow with the slip-box method, please find a relevant topic on Discourse, or create a new one.

Knowledge Bases using Org-roam

• Jethro Kuan (Source)
• Alexey Shmalko
• Sidharth Arya

Contributing

To report bugs and suggest new feature use the issue tracker. If you have some code which you would like to be merged, then open a pull request. Please also see CONTRIBUTING.md.

License

Copyright © Jethro Kuan and contributors. Distributed under the GNU General Public License, Version 3.