{"id":13443131,"url":"https://github.com/jakebox/preview-org-html-mode","last_synced_at":"2025-03-20T16:30:27.432Z","repository":{"id":165726073,"uuid":"352404728","full_name":"jakebox/preview-org-html-mode","owner":"jakebox","description":"Emacs minor mode for an (optionally) live preview of Org exports to HTML using Xwidgets.","archived":true,"fork":false,"pushed_at":"2021-09-05T16:07:11.000Z","size":3215,"stargazers_count":17,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-28T06:57:33.064Z","etag":null,"topics":["emacs","html","org-mode"],"latest_commit_sha":null,"homepage":"","language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jakebox.png","metadata":{"files":{"readme":"README.org","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-03-28T18:18:08.000Z","updated_at":"2023-05-22T00:32:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"c13ebc40-76bb-4ef7-a72c-f45a25374df4","html_url":"https://github.com/jakebox/preview-org-html-mode","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jakebox%2Fpreview-org-html-mode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jakebox%2Fpreview-org-html-mode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jakebox%2Fpreview-org-html-mode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jakebox%2Fpreview-org-html-mode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jakebox","download_url":"https://codeload.github.com/jakebox/preview-org-html-mode/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244649675,"owners_count":20487467,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emacs","html","org-mode"],"created_at":"2024-07-31T03:01:56.529Z","updated_at":"2025-03-20T16:30:26.533Z","avatar_url":"https://github.com/jakebox.png","language":"Emacs Lisp","funding_links":[],"categories":["Emacs Lisp"],"sub_categories":[],"readme":"#+TITLE: preview-org-html-mode\n#+AUTHOR: jakebox\n#+OPTIONS: num:nil toc:nil\n\n*PREVIEW-ORG-HTML-MODE HAS BECOME [[https://github.com/jakebox/org-preview-html][ORG-PREVIEW-HTML]] AND IS ON MELPA. ALL FURTHER DEVELOPMENT CAN BE FOUND THERE. THANK YOU!*\n\nThis 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]]).\n\n* Usage\nOpen 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~.\n** Commands\n+ ~preview-org-html-mode~ - enables minor mode and opens preview.\n+ ~preview-org-html-refresh~ - manually refresh preview (only needed in ~manual~ mode).\n+ ~preview-org-html-pop-window-to-frame~ - pops out the current window in to a frame.\n  \n* Variables/Configuration\n** Refresh Configuration\n+ ~preview-org-html-refresh-configuration~ - configure how often the HTML preview will be refreshed\n  * If ='manual=, update manually by running ~preview-org-html-refresh~.\n  * If ='save=, update on save (default).\n  * If ='export=, update on manual export (using ~org-html-export-to-html~).\n  * If ='timer=, update preview on timer.\n    - Configure with ~preview-org-html-timer-interval~, default ~2~ seconds.\n  * If ~instant~, update ASAP\n    - Still WIP, it is suggested to use ~timer~ mode with a short interval.\n** Viewer\n+ ~preview-org-html-viewer~ - which Emacs browser ~preview-org-html-mode~ will use (default ~eww~)\n  * If ='eww=, use eww browser (default).\n  * If ='xwidget=, use xwidget browser.\n    - *Requires Emacs to be built with xwidget support*\n      \n* Demo\nThis 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.\n[[preview-org-html-mode-demo.gif]]\n\n* Limitations\nIt 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.\n\n* Todos\n+ Improve ~instant~ mode\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjakebox%2Fpreview-org-html-mode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjakebox%2Fpreview-org-html-mode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjakebox%2Fpreview-org-html-mode/lists"}