emacs-org-sanpo icon indicating copy to clipboard operation
emacs-org-sanpo copied to clipboard

πŸšΆβ€β™€οΈ Roam-like system built on top of org-mode

#+TITLE: Org-Sanpo

CURRENT STATE: EXPERIMENTAL

Org-sanpo is a [[https://roamresearch.com/][Roam]]-like system built on top of org-mode. It is heavilly inspired by and based off of [[https://github.com/jethrokuan/org-roam][org-roam]].

There are three main differences:

  1. Headline as Note
  2. Link by ID
  3. Utilize Git for Cache
  • Configuration

To update cache properly, org-sanpo-directory must be a root directory of a git repository.

#+begin_src elisp (require 'org-sanpo) ;; Root directory for your org files. It also must be a git repository root. (setq org-sanpo-directory "~/org/") ;; The first time called cache will be created from scratch. It may take some time. (org-sanpo-mode) ;; Define some bindings. (define-key org-sanpo-mode-map (kbd "C-c n f") 'org-sanpo-find-file) (define-key org-sanpo-mode-map (kbd "C-c n t") 'org-sanpo-today) (define-key org-mode-map (kbd "C-c n i") 'org-sanpo-insert-link) #+end_src

  • TODO How to use

TODO

  • TODO Headline as Note, Link by ID

TODO

  • TODO Utilize Git for Cache

TODO

  • TODO Org-protocol Support

TODO

  • Features to be implemented

Might change.

  • [X] Org-protocol support

  • [X] Daily headline command

  • [ ] Backlink buffer

  • [ ] Relation graph

  • Dependencies

  • org, org-capture, org-protocol, org-id -- Org features

  • s, f, map -- Utils

  • magit -- To access git repo

  • emacsql/emacsql-sqlite -- To access sqlite3 database

  • [[https://github.com/raxod502/selectrum][selectrum]] -- For interactive selecting

  • TODO Related libraries

  • [[https://github.com/jethrokuan/org-roam][jethrokuan/org-roam: Rudimentary Roam replica with Org-mode]]

  • [[https://github.com/l3kn/org-zettelkasten][l3kn/org-zettelkasten: An opinionated setup for managing large collections of interlinked org files.]]