https://github.com/okomestudio/org-roam-ok
An org-roam plug-in for better PKM in Emacs.
https://github.com/okomestudio/org-roam-ok
emacs emacs-configuration emacs-package org-mode org-roam
Last synced: 3 months ago
JSON representation
An org-roam plug-in for better PKM in Emacs.
- Host: GitHub
- URL: https://github.com/okomestudio/org-roam-ok
- Owner: okomestudio
- License: gpl-3.0
- Created: 2024-08-12T22:35:27.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-02-25T05:00:16.000Z (3 months ago)
- Last Synced: 2025-02-25T06:18:17.380Z (3 months ago)
- Topics: emacs, emacs-configuration, emacs-package, org-mode, org-roam
- Language: Emacs Lisp
- Homepage:
- Size: 138 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# org-roam-ok
An [org-roam](https://github.com/org-roam/org-roam) plug-in minor mode for better PKM in
Emacs.
The enhancements include:
- Informative minibuffer lines
- Title-alias distinction
- Parent-child connection between org-roam file nodes
- Japanese-aware unlinked references parsing
- Use of hyphen for title slug
- Automatic creation of missing parent directories
- In-memory caching for faster node lookup
- etc.
This is a packaged version of my `org-roam` customization. As the related `init.el`
section has grown large, I turned it into a package to tidy up the initialization.
## Installation
To install via `use-package`, have the following lines in your `init.el`:
``` emacs-lisp
(use-package org-roam-timestamps
:after org-roam)
(use-package ok-plural
:straight (ok-plural :host github :repo "okomestudio/ok-plural.el"))
(use-package org-roam-ok
:straight (:host github :repo "okomestudio/org-roam-ok")
:init (org-roam-ok-on-idle-init-setup))
```
Running the `org-roam-ok-on-idle-init-setup` function is optional; it simply loads the
minor mode and fill the in-memory cache to speed up the very first node query. Otherwise,
use the `org-roam-ok-mode` function explicitly to enable the minor mode, e.g.,
``` emacs-lisp
(use-package org-roam
...
:config
...
(org-roam-ok-mode 1))
```
## Usage
To use the enhanced unlinked references section in the org-roam buffer, add
`org-roam-ok-ja-unlinked-refrences-section` to the `org-roam-mode-sections` variable,
e.g.:
``` emacs-lisp
(setopt org-roam-mode-sections
(list #'org-roam-backlinks-section
#'org-roam-reflinks-section
#'org-roam-ok-ja-unlinked-references-section))
```
## Customization
- `org-roam-ok-on-idle-delay` (default: 60): Idle time delay in second before the on-idle
initializer runs when `org-roam-ok-on-idle-init-setup` has been run
## Development
TBD.
## TODOs
- [ ] Document enhancements in more detail
- [ ] Make `org-roam-timestamps` dependency optional