This minor mode provides an easy preview of your org-exported HTML files using either the eww or xwidget WebKit browser. By default, when org-preview-html-mode is enabled a save will trigger a refresh of the preview. Refresh frequency can be configured using org-preview-html-refresh-configuration (see Usage).
The preferred way of installing this package is using MELPA. M-x package-install org-preview-html.
Download and copy org-preview-html.el into a directory in your load-path then (require 'org-preview-html).
Open an Org file and execute M-x org-preview-html-mode. A preview window opens next to the Org file. If you want to manage this window separate (aka, make it a frame) use the function org-preview-html-pop-window-to-frame.
org-preview-html-mode- enables minor mode and opens preview.org-preview-html-refresh- manually refresh preview (only needed inmanualmode).org-preview-html-pop-window-to-frame- pops out the current window in to a frame.
org-preview-html-refresh-configuration- configure how often the HTML preview will be refreshed- If
'manual, update manually by runningorg-preview-html-refresh. - If
'save, update on save (default). - If
'export, update on manual export (usingorg-html-export-to-html). - If
'timer, update preview on timer.- Configure with
org-preview-html-timer-interval, default2seconds.
- Configure with
- If
'instant, update ASAP- Still WIP, it is suggested to use
timermode with a short interval.
- Still WIP, it is suggested to use
- If
org-preview-html-viewer- which Emacs browserorg-preview-html-modewill use (defaulteww)- If
'eww, use eww browser (default). - If
'xwidget, use xwidget browser.- Requires Emacs to be built with xwidget support
- If
This demo is using the xwidget browser. The author suggests utilizing the xwidget browser, though eww is set as default for the comfort of past users.
It should be noted that as of now org-preview-html-mode officially supports previewing only one buffer at a time. Any suggestions on how previewing multiple buffers would work are welcome. It would be fairly trivial to implement preview support without any nice automatic switching/saving features; however, I would rather implement a smooth, pleasant experience rather than a janky one.
- Improve
instantmode - Auto-jump to current position in preview
Org-preview-html was originally written by lujun9972 (Darksun) and was originally titled (long ago) org-eww. It was rewritten by its current maintainer, jakebox. A thank you is due to Darksun for his long-time support and commitment.