org-roam

No description

Find a file

Herbert Jones b382b1f21a (docs): add documentation for multiple org-roam directories (#187 )		2020-02-26 15:23:29 +08:00
.github	(chore): Add GitHub templates (#117 )	2020-02-18 13:43:13 +08:00
doc	(docs): add documentation for multiple org-roam directories (#187 )	2020-02-26 15:23:29 +08:00
tests	(performance): avoid path expansion by referencing cache obj (#184 )	2020-02-26 00:15:38 +08:00
.gitignore	(tests): add tests for org-roam-insert (#105 )	2020-02-17 15:48:54 +08:00
.readthedocs.yml	add readthedocs.yml	2020-02-12 19:40:13 +08:00
CHANGELOG.md	(feature): support file aliases (#182 )	2020-02-26 00:11:38 +08:00
LICENSE	Add GPL License	2020-02-12 21:47:57 +08:00
Makefile	Fix several linting errors (#68 )	2020-02-13 13:20:48 +08:00
makem.sh	Fix several linting errors (#68 )	2020-02-13 13:20:48 +08:00
mkdocs.yml	(docs): Add documentation for #+ROAM_ALIAS attribute (#185 )	2020-02-26 01:33:49 +08:00
org-roam-utils.el	(feature): support file aliases (#182 )	2020-02-26 00:11:38 +08:00
org-roam.el	(performance): avoid path expansion by referencing cache obj (#184 )	2020-02-26 00:15:38 +08:00
README.md	(docs): remove `:after` from package install (#186 )	2020-02-26 11:00:24 +08:00

README.md

Synopsis

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.

A Preview

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.

Installation

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

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

For more detailed installation instructions (including instructions for Spacemacs users), please see the installation documentation.

Knowledge Bases using Org-Roam

Jethro Kuan (Source)

Changelog

A changelog is being maintained here

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.