You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Jethro Kuan ceb88e1e82
Merge pull request #58 from jethrokuan/feat/title->id
6 years ago
doc add readthedocs.yml 6 years ago
.readthedocs.yml add readthedocs.yml 6 years ago
README.md Add documentation 6 years ago
mkdocs.yml rtd customizations 6 years ago
org-roam.el add org-roam--title-to-id 6 years ago
shell.nix Add documentation 6 years ago

README.md

Documentation Status

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.

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

For more documentation, see the documentation page.

Understanding Roam

To understand more about Roam, I recommend the following links:

Project Status

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.

img

Knowledge Bases using Org-Roam

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.