Skip to content

๐Ÿšถโ€โ™€๏ธ Roam-like system built on top of org-mode

Notifications You must be signed in to change notification settings

kamoii/emacs-org-sanpo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

54 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Org-Sanpo

CURRENT STATE: EXPERIMENTAL

Org-sanpo is a Roam-like system built on top of org-mode. It is heavilly inspired by and based off of 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.

(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)

How to use

TODO

Headline as Note, Link by ID

TODO

Utilize Git for Cache

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
  • selectrum โ€“ For interactive selecting

Related libraries

About

๐Ÿšถโ€โ™€๏ธ Roam-like system built on top of org-mode

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published