All Projects → jakebox → preview-org-html-mode

jakebox / preview-org-html-mode

Licence: GPL-3.0 License
Emacs minor mode for an (optionally) live preview of Org exports to HTML using Xwidgets.

Programming Languages

emacs lisp
2029 projects

Projects that are alternatives of or similar to preview-org-html-mode

notes
just notes
Stars: ✭ 21 (+31.25%)
Mutual labels:  org-mode
emacs-up
My emacs configuration files
Stars: ✭ 23 (+43.75%)
Mutual labels:  org-mode
org-beamer-cn
[Deprecated] org-mode Simple Chinese Template for Beamer
Stars: ✭ 23 (+43.75%)
Mutual labels:  org-mode
organic
Outliner, organizer and notes management app.
Stars: ✭ 37 (+131.25%)
Mutual labels:  org-mode
org-onenote
Post org file to onenote
Stars: ✭ 40 (+150%)
Mutual labels:  org-mode
babel
A Leiningen project template for literate Clojure projects w/ org-mode
Stars: ✭ 74 (+362.5%)
Mutual labels:  org-mode
phscroll
Enable partial horizontal scroll in Emacs
Stars: ✭ 52 (+225%)
Mutual labels:  org-mode
zettel-mode
A Zettelkasten-style note-taking helper
Stars: ✭ 32 (+100%)
Mutual labels:  org-mode
ob-tmux
Ob-tmux is an Emacs library that allows org mode to evaluate code blocks in a tmux session.
Stars: ✭ 46 (+187.5%)
Mutual labels:  org-mode
emacs-modified-windows
Mirror of the GitLab project Emacs Modified for Windows
Stars: ✭ 79 (+393.75%)
Mutual labels:  org-mode
sword-to-org
Convert Sword modules to Org-mode outlines
Stars: ✭ 32 (+100%)
Mutual labels:  org-mode
org-agda-mode
An Emacs mode for working with Agda code in an Org-mode like fashion, more or less.
Stars: ✭ 14 (-12.5%)
Mutual labels:  org-mode
dotfiles
Personal config and utils for emacs, vim, tmux, i3, git, etc.
Stars: ✭ 29 (+81.25%)
Mutual labels:  org-mode
nano-agenda
A minimal org agenda for Emacs
Stars: ✭ 33 (+106.25%)
Mutual labels:  org-mode
org parser
An Org Mode parser for Dart
Stars: ✭ 21 (+31.25%)
Mutual labels:  org-mode
counsel-org-clock
Counsel (Ivy) interface for org-clock
Stars: ✭ 44 (+175%)
Mutual labels:  org-mode
tangle-rs
a collection of tools to do tangle in rust
Stars: ✭ 23 (+43.75%)
Mutual labels:  org-mode
org-tanglesync.el
A package to pull external changes into an org-mode source block if that block is tangled to an external file
Stars: ✭ 80 (+400%)
Mutual labels:  org-mode
Eorg
new version: https://github.com/SoftMaple/Editor
Stars: ✭ 27 (+68.75%)
Mutual labels:  org-mode
ntangle
Command-line utility for Tangling of Org documents — programmed in Nim.
Stars: ✭ 56 (+250%)
Mutual labels:  org-mode

preview-org-html-mode

PREVIEW-ORG-HTML-MODE HAS BECOME ORG-PREVIEW-HTML AND IS ON MELPA. ALL FURTHER DEVELOPMENT CAN BE FOUND THERE. THANK YOU!

This minor mode provides an easy preview of your org-exported HTML files using either the eww or xwidget WebKit browser. By default, when preview-org-html-mode is enabled a save will trigger a refresh of the preview. Refresh frequency can be configured using preview-org-html-refresh-configuration (see Usage).

Usage

Open an Org file and execute M-x preview-org-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 preview-org-html-pop-window-to-frame.

Commands

  • preview-org-html-mode - enables minor mode and opens preview.
  • preview-org-html-refresh - manually refresh preview (only needed in manual mode).
  • preview-org-html-pop-window-to-frame - pops out the current window in to a frame.

Variables/Configuration

Refresh Configuration

  • preview-org-html-refresh-configuration - configure how often the HTML preview will be refreshed
    • If =’manual=, update manually by running preview-org-html-refresh.
    • If =’save=, update on save (default).
    • If =’export=, update on manual export (using org-html-export-to-html).
    • If =’timer=, update preview on timer.
      • Configure with preview-org-html-timer-interval, default 2 seconds.
    • If instant, update ASAP
      • Still WIP, it is suggested to use timer mode with a short interval.

Viewer

  • preview-org-html-viewer - which Emacs browser preview-org-html-mode will use (default eww)
    • If =’eww=, use eww browser (default).
    • If =’xwidget=, use xwidget browser.
      • Requires Emacs to be built with xwidget support

Demo

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. preview-org-html-mode-demo.gif

Limitations

It should be noted that as of now preview-org-html-mode 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.

Todos

  • Improve instant mode
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].