hendrikcech / org-roam Goto Github PK

Org-roam is a rudimentary Roam replica built around the all-powerful Org-mode.

Like Roam, Org-roam offers a powerful and effortless non-hierarchical note-taking approach. With Org-roam, notes flow naturally, making note-taking fun and easy. Org-roam enables a note-taking workflow that is not fluid with vanilla Org-mode (more in this blog post).

The goal of the project is to implement core features of Roam around Org-mode, and eventually introduce features enabled by the Emacs ecosystem.

Visit the documentation page for a tutorial and more links.

As of February 2020, it is in a very early stage of development.

Here's a screenshot of org-roam. The org-roam buffer shows backlinks for the active org buffer in the left window, as well as the surrounding content in the backlink file. The backlink database is built asynchronously in the background, and is not noticeable to the end user. The graph is generated from the link structure, and can be used to navigate to the respective files.

The recommended method is using use-package and straight, or a similar package manager.

(use-package org-roam
      :after org
      :hook 
      ((org-mode . org-roam-mode)
       (after-init . org-roam--build-cache-async) ;; optional!
       )
      :straight (:host github :repo "jethrokuan/org-roam" :branch "develop")
      :custom
      (org-roam-directory "/path/to/org-files/")
      :bind
      ("C-c n l" . org-roam)
      ("C-c n t" . org-roam-today)
      ("C-c n f" . org-roam-find-file)
      ("C-c n i" . org-roam-insert)
      ("C-c n g" . org-roam-show-graph))

For more detailed installation instructions, please see the installation documentation.

• Jethro Kuan (Source)

A changelog is being maintained here

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.

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