Skip to content

Commit d2212dd

Browse files
committed
Updated README/commentary
1 parent 0448739 commit d2212dd

File tree

2 files changed

+13
-16
lines changed

2 files changed

+13
-16
lines changed

README.org

+8-8
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,17 @@ Open an Org file and execute ~M-x org-preview-html-mode~. A preview window opens
2323
* Variables/Configuration
2424
** Refresh Configuration
2525
+ ~org-preview-html-refresh-configuration~ - configure how often the HTML preview will be refreshed
26-
* If ~'manual~, update manually by running ~org-preview-html-refresh~.
27-
* If ~'save~, update on save (default).
28-
* If ~'export~, update on manual export (using ~org-html-export-to-html~).
29-
* If ~'timer~, update preview on timer.
26+
* If ~'manual~, update manually by running ~org-preview-html-refresh~.
27+
* If ~'save~, update on save (default).
28+
* If ~'export~, update on manual export (using ~org-html-export-to-html~).
29+
* If ~'timer~, update preview on timer.
3030
- Configure with ~org-preview-html-timer-interval~, default ~2~ seconds.
31-
* If ~'instant~, update ASAP
31+
* If ~'instant~, update ASAP
3232
- Still WIP, it is suggested to use ~timer~ mode with a short interval.
3333
** Viewer
3434
+ ~org-preview-html-viewer~ - which Emacs browser ~org-preview-html-mode~ will use (default ~eww~)
35-
* If ~'eww~, use eww browser (default).
36-
* If ~'xwidget~, use xwidget browser.
35+
* If ~'eww~, use eww browser (default).
36+
* If ~'xwidget~, use xwidget browser.
3737
- *Requires Emacs to be built with xwidget support*
3838

3939
* Demo
@@ -48,4 +48,4 @@ It should be noted that as of now =org-preview-html-mode= officially supports pr
4848
+ Auto-jump to current position in preview
4949

5050
* Credits
51-
Org-preview-html was originally written by [[https://github.com/lujun9972][lujun9972 (Darksun)]]. It was rewritten by its current maintainer, [[https://github.com/jakebox][jakebox]]. A thank you is due to Darksun for his long-time support and commitment.
51+
Org-preview-html was originally written by [[https://github.com/lujun9972][lujun9972 (Darksun)]] and was originally titled (long ago) org-eww. It was rewritten by its current maintainer, [[https://github.com/jakebox][jakebox]]. A thank you is due to Darksun for his long-time support and commitment.

org-preview-html.el

+5-8
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,19 @@
2525
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
2626

2727
;;; Commentary:
28-
;;
2928
;; This minor mode provides a side-by-side preview of your org-exported HTML
3029
;; files using the either the eww or xwidget browsers. The update frequency of
3130
;; the preview can be configured to suit your preference.
3231
;;
33-
34-
;;; Source code
35-
;;
36-
;; org-preview-html's code can be found here:
37-
;; http://github.com/jakebox/org-preview-html
38-
39-
;;; Quick start:
32+
;; Quick start:
4033
;; Put this file under your load path.
4134
;; Enable the minor mode in an Org buffer:
4235
;; M-x org-preview-html-mode
4336
;; Configure options with M-x customize-group org-preview-html
37+
;;
38+
;; Source code
39+
;; org-preview-html's code can be found here:
40+
;; http://github.com/jakebox/org-preview-html
4441

4542
;;; Code:
4643

0 commit comments

Comments
 (0)