Create epub files using Ruby.
gem install epub-rb
Or add the following line to your project's Gemfile:
gem "epub-rb"
require "epub"
epub = Epub.new(
root_dir: "./book",
title: "Hello World",
subtitle: "A Complete Beginner’s Guide to Ruby Programming",
creators: ["John Doe"],
publisher: "epub-rb",
date: "2024-01-24",
id: "d05f92ea-62f7-44d6-bb48-d94c11e660db",
copyright: "Copyright 2024 by John Doe",
identifiers: ["915869090000000000DD", "urn:isbn:9780000000001"],
contributors: ["Jane Doe"],
files: [
"./book/book.css",
"./book/cover.png",
"./book/cover.html",
"./book/toc.html",
"./book/ch01.html",
"./book/ch02.html",
"./book/images/terminal.svg"
]
)
epub.save("hello-word.epub")
The epub file is compliant with the EPUB 3.3 specification. You can check it by using epubcheck.
[!NOTE]
epub-rb makes a few assumptions that you need to follow.
- You need to have a file name
toc.{xhtml,html}. This file must be compliant with the EPUB 3 spec.- You'll also need a cover image named as
cover.{png,jpg,gif}.- You'll also need a companion file called
cover.{xhtml,html}.
You can use the methods Epub::Navigation.extract(files, root_dir:) and
Epub::Navigation.extract_html(files, root_dir:) to generate the toc.html
file. A simple way would be using something like this:
navigation = Epub::Navigation.extract_html(
Dir["./book/**/*.html"],
root_dir: "./book"
)
File.open("toc.html", "w") do |file|
file << <<~HTML
<?xml version='1.0' encoding='utf-8'?>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Table of Contents</title>
</head>
<body>
#{navigation}
</body>
</html>
HTML
end
[!NOTE]
Notice that the order of
.html/.xhtmlfiles is important. You need to sort files how you'd like them to show up. If you addtoc.htmllastly, then it'll show up at the end of the ebook.Consider adding files in this order:
cover.html,toc.html, all other html files your epub will have, then other assets (images, css, javascript, etc).
For more details about how to contribute, please read https://github.com/fnando/epub/blob/main/CONTRIBUTING.md.
The gem is available as open source under the terms of the MIT License. A copy of the license can be found at https://github.com/fnando/epub/blob/main/LICENSE.md.
Everyone interacting in the epub-rb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
FAQs
Unknown package
We found that epub-rb demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.