org-roam

No description

Find a file

Jethro Kuan 7dd371c023 (fix?): use helm-make-source instead (#375 ) Byte-compiled code should not contain macros.		2020-03-29 21:30:23 +08:00
.github	(chore): update internal Github settings (#339 )	2020-03-22 11:37:23 +08:00
doc	(docs): Add note about completion mechanism (#373 )	2020-03-29 17:58:49 +08:00
tests	(internal): modularize features (#363 )	2020-03-28 21:16:28 +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	(feat): add variable for muting messages (#359 )	2020-03-27 15:09:52 +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 exporting backlinks in Org file (#244 )	2020-03-07 23:49:43 +08:00
org-roam-capture.el	(hotfix): move capture in-process setting as late as possible (#372 )	2020-03-29 17:52:22 +08:00
org-roam-completion.el	(fix?): use helm-make-source instead (#375 )	2020-03-29 21:30:23 +08:00
org-roam-db.el	(internal): modularize features (#363 )	2020-03-28 21:16:28 +08:00
org-roam-graph.el	(internal): modularize features (#363 )	2020-03-28 21:16:28 +08:00
org-roam-macs.el	(internal): modularize features (#363 )	2020-03-28 21:16:28 +08:00
org-roam-protocol.el	(feat): Add interactive org-roam-capture (#371 )	2020-03-29 17:29:57 +08:00
org-roam.el	(feat): Add interactive org-roam-capture (#371 )	2020-03-29 17:29:57 +08:00
README.md	(release): v1.0.0 (#341 )	2020-03-23 15:34:21 +08:00

README.md

Synopsis

Org-roam is a Roam replica built on top of the all-powerful Org-mode.

Org-roam is a solution for effortless non-hierarchical note-taking with Org-mode. With Org-roam, notes flow naturally, making note-taking fun and easy. Org-roam should also work as a plug-and-play solution for anyone already using Org-mode for their personal wiki.

Org-roam aims to implement the core features of Roam, leveraging the mature ecosystem around Org-mode where possible. Eventually, we hope to further introduce features enabled by the Emacs ecosystem.

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

Important links:

Documentation
Org-roam Slack

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 database is built once, and updated incrementally. The graph is generated from the link structure, and can be used to navigate to the respective files.

Installation

You can install org-roam using package.el:

M-x package-install RET org-roam RET

Here's a sample configuration with using use-package:

(use-package org-roam
      :hook 
      (after-init . org-roam-mode)
      :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 and configuration instructions (including for Doom and Spacemacs users), please see the 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.