chenyanming / nov-xwidget Goto Github PK

The best epub reader in Emacs

Emacs Lisp 100.00%

nov-xwidget's Introduction

nov-xwidget - the best epub reader in Emacs

Introduction

nov-xwidget extends nov.el with the built-in xwidget webkit (You have to compile Emacs with xwidget support) and render the epub html/xhtml files with any customized CSS styles or JavaScript scripts.

Features

Render epub with any CSS or JavaScript scripts, including but not limited to fonts, layout etc.
Support dark or light mode
For some systems that can not use xwidget, set nov-xwidget-browser-function to other browser functions, e.g. browse-url.

Installation and Configuration

(use-package nov-xwidget
  :demand t
  :after nov
  :config
  (define-key nov-mode-map (kbd "o") 'nov-xwidget-view)
  (add-hook 'nov-mode-hook 'nov-xwidget-inject-all-files))

Three options for you to configure:

nov-xwidget-script
nov-xwidget-style-light
nov-xwidget-style-dark

Usage

Open an epub file in Emacs, then M-x nov-xwidget-view to change to xwidget webkit buffer.

Function	Feature
`xwidget-webkit-back`	Back
`xwidget-webkit-forward`	Forward
`nov-xwidget-goto-toc`	Goto table of contents
`nov-xwidget-next-document`	Goto next document
`nov-xwidget-previous-document`	Goto previous document
`nov-xwidget-find-source-file`	Goto the original source file
`nov-xwidget-inject-all-files`	Apply styles and scripts to all documents in one epub

Contributions

I need your helps on adding more advanced styles or scripts. Add more features and make Emacs as the best epub reader!

nov-xwidget's People

Contributors

Stargazers

Watchers

Forkers

syohex alxbnct astery alan-w-255 luggages citizen428 qyqx yaqubroli qiutum tushartyagi

nov-xwidget's Issues

Invalid function: evil-define-key

error throw while installing package. I think evil-define-key is macro cause this error.

Can not find this package in repositories

(error "Package ‘nov-xwidget-’ is unavailable")

[Bug] Wrong type argument: arrayp, nil

On nov-xwidget-view I got this: Wrong type argument: arrayp, nil

My nov-xwidget settings:

	(load "~/.emacs.d/local-packages/nov-xwidget")
	(require 'nov-xwidget)

	;; Best .epub reader
	(use-package nov-xwidget
		:demand t
		:after nov
		:config
		(define-key nov-mode-map (kbd "o") 'nov-xwidget-view)
		(add-hook 'nov-mode-hook 'nov-xwidget-inject-all-files))

My emacs was built with GTK3 and xwidget

OS: Arch Linux, KDE Plasma: v. 5.26.5

After clicking href, the current document location is not updated.

cursor and highlight line mode

Hi, I'm trying this package out for reading epub files in Emacs. It makes the book looks a lot better, and very close to the actual book layout.

while i read, i use the cursor as a guide to help me stay focused. i use hl-line mode for the same reason, to get below, i just call hl-line-mode, but it makes no effects in nov-xwidget, would you able to help?

[Bug] wrong-type-argument error

While opening epub books, I got this error.

Debugger entered--Lisp error: (wrong-type-argument consp nil)
  setcar(nil "Go语言程序设计: ")
  (if (listp v) (setcar (nthcdr 2 v) title) (aset v 2 title))
  (let* ((v (car (dom-by-tag dom 'title)))) (if (listp v) (setcar (nthcdr 2 v) title) (aset v 2 title)))
  (let ((dom dom)) (dom-append-child (dom-by-tag dom 'head) '(meta ((charset . "utf-8")))) (dom-append-child (dom-by-tag dom 'head) (list 'style nil (let* ((val (frame-parameter nil 'background-mode))) (cond ((eq val 'light) (let nil nov-xwdiget-style-light)) ((eq val 'dark) (let nil nov-xwdiget-style-dark)) (t (let nil nov-xwdiget-style-light)))))) (dom-append-child (dom-by-tag dom 'head) (list 'script nil nov-xwidget-script)) (let* ((v (car (dom-by-tag dom 'title)))) (if (listp v) (setcar (nthcdr 2 v) title) (aset v 2 title))) dom)
  (let* ((native-path (expand-file-name (if (eq major-mode 'calibredb-search-mode) (calibredb-get-file-path candidate t) candidate))) (output-native-file-name (if (or (string-equal (file-name-extension native-path) "html") (string-equal (file-name-extension native-path) "xhtml")) (format "_%s.html" (file-name-base native-path)) (file-name-nondirectory native-path))) (output-native-path (expand-file-name output-native-file-name (file-name-directory native-path))) (dom (let ((temp-buffer (generate-new-buffer " *temp*" t))) (save-current-buffer (set-buffer temp-buffer) (unwind-protect (progn (insert-file-contents native-path) (libxml-parse-html-region ... ...)) (and (buffer-name temp-buffer) (kill-buffer temp-buffer)))))) (title (format "%s: %s" (alist-get 'title nov-metadata) (dom-text (dom-by-tag dom 'title)))) (new-dom (let ((dom dom)) (dom-append-child (dom-by-tag dom 'head) '(meta (...))) (dom-append-child (dom-by-tag dom 'head) (list 'style nil (let* (...) (cond ... ... ...)))) (dom-append-child (dom-by-tag dom 'head) (list 'script nil nov-xwidget-script)) (let* ((v (car ...))) (if (listp v) (setcar (nthcdr 2 v) title) (aset v 2 title))) dom)) (file (let ((temp-file output-native-path) (temp-buffer (generate-new-buffer " *temp file*" t))) (unwind-protect (prog1 (save-current-buffer (set-buffer temp-buffer) (shr-dom-print new-dom) output-native-path) (save-current-buffer (set-buffer temp-buffer) (write-region nil nil temp-file nil 0))) (and (buffer-name temp-buffer) (kill-buffer temp-buffer))))) (path (replace-regexp-in-string " " "%20" (concat "file:///" file)))) (if arg (let ((calibredb-preferred-format nil)) (nov-xwidget-webkit-browse-url-other-window path new-session 'switch-to-buffer)) (nov-xwidget-webkit-browse-url-other-window path new-session 'switch-to-buffer)))
  nov-xwidget-webkit-find-file("/var/folders/tg/2sc4fy1x3ksfznc8mw2h55040000gn/T/n..." nil t)
  (let* ((docs nov-documents) (index nov-documents-index) (toc nov-toc-id) (epub nov-epub-version) (metadata nov-metadata)) (nov-xwidget-webkit-find-file (cdr (aref docs index)) nil t) (save-current-buffer (set-buffer (xwidget-buffer (xwidget-webkit-current-session))) (set (make-local-variable 'nov-documents) docs) (set (make-local-variable 'nov-documents-index) index) (set (make-local-variable 'nov-toc-id) toc) (set (make-local-variable 'nov-epub-version) epub) (set (make-local-variable 'nov-metadata) metadata)))
  nov-xwidget-view()
  funcall-interactively(nov-xwidget-view)
  #<subr command-execute>(nov-xwidget-view nil nil nil)
  ad-Advice-command-execute(#<subr command-execute> nov-xwidget-view)
  apply(ad-Advice-command-execute #<subr command-execute> nov-xwidget-view)
  command-execute(nov-xwidget-view)

make the nov-xwdiget-style configurable

something like this

(defun get-nov-xwidget-style()
    (pcase nov-xwidget-style
      ('light nov-xwidget-style-light)
      ('dark nov-xwidget-style-dark)
      ('auto (pcase (frame-parameter nil 'background-mode)
               ('light nov-xwidget-style-light)
               ('dark nov-xwidget-style-dark)
               (_ nov-xwidget-style-light)))))

Add feature of opening epub directly

Does not work on Linux.

Since xwidget on Linux cannot open local html file, opening an epub file with nov-xwidget will result in a blank page only. It is a known bug of WebKitGTK, other WebKitGTK-based browser cannot open local html file either, e.g. epiphany. See Emacs (bug #55804).