https://github.com/mcandre/nile
ebook normalizer
https://github.com/mcandre/nile
Last synced: about 1 year ago
JSON representation
ebook normalizer
- Host: GitHub
- URL: https://github.com/mcandre/nile
- Owner: mcandre
- License: other
- Created: 2022-12-15T05:46:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T00:30:54.000Z (about 1 year ago)
- Last Synced: 2025-04-15T10:09:23.166Z (about 1 year ago)
- Language: Shell
- Size: 4.17 MB
- Stars: 14
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# nile: ebook normalizer
# EXAMPLE
```console
$ cd examples
$ nile shakespeare.epub
$ ls
shakespeare.epub
shakespeare.normalized.epub
```
See `nile -h` for more detail.
# ABOUT
nile normalizes ebooks. For example, Amazon Kindle ereaders often fail to render smart (double-)quotes, apostrophes, em dashes, and other common Unicode runes properly. These can corrupt the displayed page, interrupting the natural flow of content.
nile patches up common ePUB structural integrity quirks, for an easier reading experience.
# WARNINGS
The ebook pages must not contain intensely bizarre oddities, such as a Unicode non-breaking space as a literal rune, or else the ebook may trigger a generic Amazon WhisperSync upload error. For example, the .(x)htm(l) files within the ebook will need to be able to render well in macOS Quick Look and Google Chrome, prior to any sanitization with nile.
Some ebooks may present latent glitches, which can trigger when Calibre converting, such as after applying a custom book cover. This is due to oddities in how Calibre processes CSS.
Some ebooks may not upload at all! We apply some `tidy` cleanup preprocessing, but even that can't account for all possible ebook file corruption. Your mileage may vary.
# LICENSE
BSD-2-Clause
# RUNTIME REQUIREMENTS
* [GNU](https://www.gnu.org/)/[BSD](https://en.wikipedia.org/wiki/Berkeley_Software_Distribution) [findutils](https://en.wikipedia.org/wiki/Find_(Unix))
* [GNU](https://www.gnu.org/) compatible [readlink](https://www.gnu.org/software/coreutils/manual/html_node/readlink-invocation.html)
* POSIX compatible [sh](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/sh.html)
* If the ebook filename, or any compressed entry filenames, contain non-ASCII runes, then the active shell interpreter encoding must support that encoding.
* [tidy-html5](https://github.com/htacg/tidy-html5) 5.6+
* [xmlstarlet](https://xmlstar.sourceforge.net/) 1.6.1+
* [zip](https://infozip.sourceforge.net/)
# INSTALL
For more information on installing or uninstalling nile, see [INSTALL.md](INSTALL.md).
# CONTRIBUTING
For more information on developing nile itself, see [DEVELOPMENT.md](DEVELOPMENT.md).
# SEE ALSO
* [bao](https://github.com/mcandre/bao), a PDF compressor
* [Calibre](https://calibre-ebook.com/), a comprehensive personal ebook library manager
* [Pandoc](https://pandoc.org/), a file format converter
* [Sigil](https://sigil-ebook.com/), an ebook editor
* [tigris](https://github.com/mcandre/tigris), (Kindle) comic archival utilities