21

GitHub - kamoii/emacs-org-sanpo: 🚶‍♀️ Roam-like system built on top of org-mode

 4 years ago
source link: https://github.com/kamoii/emacs-org-sanpo
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

README.org

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
    • Currently its not uploaded to MELPA

Related libraries


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK