ickabog-ebook/README.md

# ickabog-ebook ![](https://img.shields.io/badge/Chapters%20Published-21%2F34-brightgreen)

Generates ebooks for The Ickabog by J.K Rowling. Original text from https://www.theickabog.com/. Since the book is still being published, please consider this "in-progress".

## Dependencies:

- `wget`
- [`pup`](https://github.com/ericchiang/pup)
- [`pandoc`](https://pandoc.org/) to generate EPUB and PDF files
- `qpdf` to add cover to PDF files. (optional)
- `kindlegen` or `calibre` installed to generate MOBI files. (optional)

## How to run

`./generate.sh`

You should have `ickabog.epub`, and `ickabog.pdf` in the `out` directory after the script finishes.

- If you have [ConTeXt][context] installed, you will also get a `out/ickabog-large.pdf` file with large fonts to be kid-friendly.
- If you have `qpdf` installed, the PDF files will have cover pages
- If you have `calibre` or `kindlegen` installed, a `out/ickabog.mobi` file will also be generated. Preference is given to `kindlegen`.

## Known Issues

The PDF is optimized for few pages of printing, so has a small font size by default. If you'd like a kid-friendly version, [install context][context] to get `ickabog-large.pdf` file.

## Extra

A list of my other EBook generation projects: https://captnemo.in/ebooks/, includes a link to other related projects as well.

## Credits

The cover art is [Avanyu](http://edan.si.edu/saam/id/object/1979.144.85) by Julian Martinez. Used under Creative Commons license.

> Julian Martinez, Avanyu, ca. 1923, watercolor, ink, and pencil on paper, Smithsonian American Art Museum, Corbin-Henderson Collection, gift of Alice H. Rossin, 1979.144.85

Code for internationalization and automatic chapter updates via [@lesensei](https://github.com/lesensei/ickabog-ebook/commits/master)'s fork.

## License

The little code in this repository is licensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.

[context]: https://wiki.contextgarden.net/Main_Page
Switch progress badge 2020-06-09 08:24:36 +00:00			`# ickabog-ebook ![](https://img.shields.io/badge/Chapters%20Published-21%2F34-brightgreen)`
Initial commit 2020-05-28 19:43:58 +00:00
Adds chapters upto 19 2020-06-05 20:52:21 +00:00			`Generates ebooks for The Ickabog by J.K Rowling. Original text from https://www.theickabog.com/. Since the book is still being published, please consider this "in-progress".`
Initial commit 2020-05-28 19:43:58 +00:00
			`## Dependencies:`

			- `wget`
			- [`pup`](https://github.com/ericchiang/pup)
Improve generation by adapting code from @lesensei - Auto generation of chapters, no manual updates - Internationalization support, thanks to @lesensei - Made qpdf, kindlegen, calibre optional dependencies - Changed the cover image size to exactly A4 - Generatd cover.pdf, and switched to qpdf from pdftk I like pdftk, but the installation is stupidly hard these days and qpdf seems to be much more lightweight. The disadvantage is losing the bookmarks in the PDF Also faced a few issues on pandoc while working on this, created issues on the pandoc repo: https://github.com/jgm/pandoc/issues/created_by/captn3m0 2020-06-09 12:37:35 +00:00			- [`pandoc`](https://pandoc.org/) to generate EPUB and PDF files
			- `qpdf` to add cover to PDF files. (optional)
			- `kindlegen` or `calibre` installed to generate MOBI files. (optional)
Initial commit 2020-05-28 19:43:58 +00:00
			`## How to run`

			`./generate.sh`

Updates README with details on optional dependencies 2020-06-09 12:41:28 +00:00			You should have `ickabog.epub`, and `ickabog.pdf` in the `out` directory after the script finishes.

			- If you have [ConTeXt][context] installed, you will also get a `out/ickabog-large.pdf` file with large fonts to be kid-friendly.
			- If you have `qpdf` installed, the PDF files will have cover pages
			- If you have `calibre` or `kindlegen` installed, a `out/ickabog.mobi` file will also be generated. Preference is given to `kindlegen`.
Initial commit 2020-05-28 19:43:58 +00:00
Large font PDF 2020-05-28 19:59:29 +00:00			`## Known Issues`
Initial commit 2020-05-28 19:43:58 +00:00
Link to context 2020-06-09 08:29:18 +00:00			The PDF is optimized for few pages of printing, so has a small font size by default. If you'd like a kid-friendly version, [install context][context] to get `ickabog-large.pdf` file.
Large font PDF 2020-05-28 19:59:29 +00:00
			`## Extra`

Adds cover art 2020-05-29 23:15:28 +00:00			`A list of my other EBook generation projects: https://captnemo.in/ebooks/, includes a link to other related projects as well.`

			`## Credits`

			`The cover art is [Avanyu](http://edan.si.edu/saam/id/object/1979.144.85) by Julian Martinez. Used under Creative Commons license.`

			`> Julian Martinez, Avanyu, ca. 1923, watercolor, ink, and pencil on paper, Smithsonian American Art Museum, Corbin-Henderson Collection, gift of Alice H. Rossin, 1979.144.85`
Initial commit 2020-05-28 19:43:58 +00:00
Improve generation by adapting code from @lesensei - Auto generation of chapters, no manual updates - Internationalization support, thanks to @lesensei - Made qpdf, kindlegen, calibre optional dependencies - Changed the cover image size to exactly A4 - Generatd cover.pdf, and switched to qpdf from pdftk I like pdftk, but the installation is stupidly hard these days and qpdf seems to be much more lightweight. The disadvantage is losing the bookmarks in the PDF Also faced a few issues on pandoc while working on this, created issues on the pandoc repo: https://github.com/jgm/pandoc/issues/created_by/captn3m0 2020-06-09 12:37:35 +00:00			`Code for internationalization and automatic chapter updates via [@lesensei](https://github.com/lesensei/ickabog-ebook/commits/master)'s fork.`

Initial commit 2020-05-28 19:43:58 +00:00			`## License`

Adds cover art 2020-05-29 23:15:28 +00:00			`The little code in this repository is licensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.`
Link to context 2020-06-09 08:29:18 +00:00
			`[context]: https://wiki.contextgarden.net/Main_Page`