https://github.com/ksqsf/logseq-open-in-emacs
https://github.com/ksqsf/logseq-open-in-emacs
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ksqsf/logseq-open-in-emacs
- Owner: ksqsf
- License: mit
- Created: 2022-12-17T09:40:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-05T18:10:01.000Z (over 1 year ago)
- Last Synced: 2025-04-13T11:09:47.867Z (about 1 month ago)
- Language: Vue
- Homepage:
- Size: 3.84 MB
- Stars: 18
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Open Logseq in Emacs
Open and edit Logseq pages and config files in Emacs.
## NEWS
* v0.0.4
- New: "Open Current Page" will now try to jump to the physical position of the current block. This requires Emacs config update (see the new sample config).
+ Caution: The position can be wrong! This feature is implemented by sending a piece of block contents, and then Emacs does a full text search.
+ Disable this feature by removing the search from the Emacs-side config.
* v0.0.3
- Update to be compatible with Logseq v0.9.1. **IMPORTANT**: If you are using older versions (prior to v0.9.1) and experience compatibility issues, please downgrade to 0.0.2 manually.
* v0.0.2
- Command Palette support. Try `mod+shift+p`.
- Add a keyboard shortcut to edit the current page (default `mod+o`).
## Configuration
First, [set up Org-protocol](https://orgmode.org/worg/org-contrib/org-protocol.html). This is due to the limitations of Logseq and, in general, Electron.
Second, add the following sample config to your Emacs config file:
```lisp
(use-package org-protocol
:ensure org
:config
(add-to-list 'org-protocol-protocol-alist
'("org-find-file" :protocol "find-file" :function org-protocol-find-file :kill-client nil))
(defun org-protocol-find-file-fix-wsl-path (path)
"If inside WSL, change Windows-style paths to WSL-style paths."
(if (not (string-match-p "-[Mm]icrosoft" operating-system-release))
path
(save-match-data
(if (/= 0 (string-match "^\\([a-zA-Z]\\):\\(/.*\\)" path))
path
(let ((volume (match-string-no-properties 1 path))
(abspath (match-string-no-properties 2 path)))
(format "/mnt/%s%s" (downcase volume) abspath))))))
(defun org-protocol-find-file (fname)
"Process org-protocol://find-file?path= style URL."
(let* ((parsed (org-protocol-parse-parameters fname nil '(:path :anchor)))
(f (plist-get parsed :path))
(anchor (plist-get parsed :anchor))
(anchor-re (and anchor (concat "\\(-\\|\\*\\) " (regexp-quote anchor)))))
(find-file (org-protocol-find-file-fix-wsl-path f))
(raise-frame)
(select-frame-set-input-focus (selected-frame))
(unhighlight-regexp t)
(highlight-regexp anchor-re)
(when anchor
(or (re-search-forward anchor-re nil t 1)
(re-search-backward anchor-re nil t 1))))))
```
To verify your config, run the following commands,
```shell
# To confirm that your Emacs config is correct:
emacsclient -c 'org-protocol://find-file?path=/tmp/some_file.txt'
# To confirm that org-protocol has been registered with your system,
# if on Linux:
xdg-open 'org-protocol://find-file?path=/tmp/some_file.txt'
# if on macOS
open 'org-protocol://find-file?path=/tmp/some_file.txt'
```
they all should open a new Emacs frame that visits `/tmp/some_file.txt`.
(Yes, you could have shortcut the protocol thing, but org-protocol is popular and widely supported, so why not? :-)
## Development
- `npm install && npm run build` in terminal to install dependencies.
- `Load unpacked plugin` in Logseq Desktop client.
## Credits
This plugin is a fork of [open-in-code](https://github.com/rebornix/logseq-open-in-code).