bramadams / embark-org-roam

Embark export buffer for org roam nodes

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

embark-org-roam

This package provides an embark export buffer for org roam nodes, which is super-useful when “harvesting” your org-roam knowledge base for sources to be used for a specific paper, diary entry, development task, etc. The buffer uses org-mode, and by default lists the selected org roam nodes in a checklist, allowing to check off items as you are processing them.

Screenshots

The first screenshot shows a checklist version of the org roam export buffer, while the second screenshot shows a read-only version of the buffer. These buffers were obtained by searching org roam nodes for entries matching the term “python”, then embark-select-ing the org roam nodes of interest, followed by embark-export.

Contents

Installation

MELPA

Just browse MELPA packages using, for instance, M-x package-list-packages, and search for embark-org-roam. To set up access to the MELPA and/or MELPA Stable repositories, see these instructions.

Manual

Install these required packages:

  • embark
  • org-roam

Then put this file in your load-path, and put this in your init file:

(require 'embark-org-roam)

Straight

Put this in your init file:

(use-package embark-org-roam
   :ensure t
   :straight (embark-org-roam
              :type git
              :host github
              :repo "bramadams/embark-org-roam")
   :after (org-roam embark)
   :demand t)

Elpaca

Put this in your init file:

(use-package embark-org-roam
   :ensure t
   :elpaca (embark-org-roam
            :type git
            :host github
            :repo "bramadams/embark-org-roam")
   :after (org-roam embark)
   :demand t)

Usage

Use embark-select to select all org roam nodes of interest, then use embark-export, which will open a special org mode buffer containing links to the selected nodes.

You can customize whether the exported buffer is read-only using the embark-org-roam-readonly variable. By default, the buffer is not read-only, resulting in an org-mode checklist.

Changelog

0.2

MELPA-reviewed release.

0.1

Initial release.

Credits

This package would not have been possible without the following magnificent packages: org-roam and embark. Also a big thanks to alphapapa for their Emacs package development handbook!

Development

Any bug reports, feature requests, suggestions, etc. welcome!

License

GPLv3

About

Embark export buffer for org roam nodes

License:GNU General Public License v3.0


Languages

Language:Emacs Lisp 100.0%