Skip to content

feat: support real-time refresh for markdown file #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seagle0128 merged 1 commit into from
Feb 13, 2026
Merged

feat: support real-time refresh for markdown file #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,9 @@ Run `M-x customize-group RET grip RET` or set the variables.

;; Sleep seconds to ensure the server starts
(setq grip-sleep-time 2)

;; Set to allow real-time refresh
(setq grip-real-time-refresh t)
```

If you don't set them you may have limitation to access Github APIs. Please
Expand Down
31 changes: 24 additions & 7 deletions grip-mode.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,11 @@ Only available for `grip'."
:type 'integer
:group 'grip)

(defcustom grip-real-time-refresh nil
"Boolean value to allow real time refresh without saving the file. Support for markdown file only."
:type 'boolean
:group 'grip)



;; Externals
Expand Down Expand Up @@ -167,6 +172,10 @@ Use default browser unless `xwidget' is available."
(format "http://%s:%d/%s" grip-preview-host grip--port
(file-name-nondirectory grip--preview-file))))

(defun grip--refresh (&rest args)
"Save into the temp file to trigger refresh."
(write-region (point-min) (point-max) grip--preview-file nil 'quiet))

(defun grip-start-process ()
"Render and preview."
(unless (process-live-p grip--process)
Expand Down Expand Up @@ -204,7 +213,9 @@ Use default browser unless `xwidget' is available."
(message "%s: Preview `%s' on %s"
grip--command
(abbreviate-file-name buffer-file-name)
(grip--preview-url)))))
(grip--preview-url))))
;; Support real-time refresh
(if grip-real-time-refresh (add-hook 'after-change-functions (function grip--refresh) nil t)))
('go-grip
(unless (executable-find "go-grip")
(grip-mode -1)
Expand Down Expand Up @@ -273,15 +284,21 @@ Use default browser unless `xwidget' is available."
(delete-process grip--process)
(message "Process `%s' killed" grip--process)
(setq grip--process nil)
(setq grip--port 6418)
;; Delete preview temporary file
(when (and grip--preview-file
(not (string-equal grip--preview-file buffer-file-name)))
(delete-file grip--preview-file))))
(setq grip--port 6418))
;; Delete preview temporary file; As for kill-emacs case the process
;; could be killed by other ways, process may not existed, hence
;; deleting the file is separating out for the clean-up process.
(when (and grip--preview-file
(not (string-equal grip--preview-file buffer-file-name)))
(delete-file grip--preview-file)))

(defun grip--preview-md ()
"Render and preview markdown with grip."
(setq grip--preview-file buffer-file-name)
(if grip-real-time-refresh
(progn
(setq grip--preview-file (concat buffer-file-name ".temp.md"))
(copy-file buffer-file-name grip--preview-file "overwrite"))
(setq grip--preview-file buffer-file-name))
(grip-start-process))

(defun grip-org-to-md (&rest _)
Expand Down