randomwangran / roam-with-helm

A fast navigation system for Org-Roam using helm

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Installation

Clone or download this repository (path of the folder is the used below).

If using Org Roam v2, clone (or download) the helm-org-walk repository.

In your ~/.emacs, add the following two lines:

(add-to-list 'load-path "<roam-with-helm>")
(require 'roam-with-helm)

Or for version 2:

(add-to-list 'load-path "<roam-with-helm>")
(add-to-list 'load-path "<helm-org-walk>")
(require 'roam-with-helm-v2)

Usage

By press: `M-x roam-with-helm-org-roam-find-file`

(define-key org-mode-map (kbd "C-c f") 'roam-with-helm-org-roam-find-file)

Or for version-2

(global-set-key (kbd "C-c f") 'helm-org-roam)

Jump to the content

After input the title, press RET to visit the file

Preview the content

In helm, press C-c C-f. When navigation, you can preview the content.

Insert the contents as a transclusion link.

This requires user to mark the candidates by pressing C-SPC. After the selection, press RET to insert the candidates as transclusions.

Issue

It cannot insert a normal link as org-roam-insert-immediate on the fly depending on existence of notes.

So, this function is tweaked as a separated function. You can use your favorite completing system as you used to.

About

A fast navigation system for Org-Roam using helm

License:GNU General Public License v3.0


Languages

Language:Emacs Lisp 100.0%