All Projects → javierarce → Epub Boilerplate

javierarce / Epub Boilerplate

Licence: mit
A simple template to help you create ePub-formatted books.

Labels

Projects that are alternatives of or similar to Epub Boilerplate

Lector
Qt based ebook reader
Stars: ✭ 1,218 (+782.61%)
Mutual labels:  epub
Calibre
The official source code repository for the calibre ebook manager
Stars: ✭ 11,221 (+8031.16%)
Mutual labels:  epub
Markdownslides
MarkdownSlides is a Reveal.js and PDF slides generator from MARKDOWN files, that also generate HTML, EPUB and DOCX documents. The idea is that from a same MARKDOWN file we can get slides and books without worrying about style, just worrying about content.
Stars: ✭ 121 (-12.32%)
Mutual labels:  epub
Koreader Base
Base framework offering a Lua scriptable environment for creating document readers
Stars: ✭ 81 (-41.3%)
Mutual labels:  epub
Go Epub
Go library for creating EPUB files
Stars: ✭ 95 (-31.16%)
Mutual labels:  epub
Kobo Book Downloader
A tool to download your purchased Kobo books and remove the DRM from them.
Stars: ✭ 117 (-15.22%)
Mutual labels:  epub
Readium Shared Js
Repository for the shared JavaScript libraries that are used in the SDK-Launchers and other applications developed on top of the SDK
Stars: ✭ 72 (-47.83%)
Mutual labels:  epub
Books
IT技术书籍文字版mobi epub格式
Stars: ✭ 131 (-5.07%)
Mutual labels:  epub
Amusewiki
Text::Amuse-based publishing platform
Stars: ✭ 95 (-31.16%)
Mutual labels:  epub
Worm Scraper
Scrapes the web serial Worm and its sequel Ward into an eBook format
Stars: ✭ 118 (-14.49%)
Mutual labels:  epub
Kotlin Reference Chinese
Kotlin 官方文档(参考部分)中文版
Stars: ✭ 85 (-38.41%)
Mutual labels:  epub
Epub Manga Creator
a web GUI for create japanese epub manga
Stars: ✭ 90 (-34.78%)
Mutual labels:  epub
Kreader
Android阅读器
Stars: ✭ 117 (-15.22%)
Mutual labels:  epub
Work crawler
Download comics novels 小说漫画下载工具 小説漫画のダウンローダ 小說漫畫下載:腾讯漫画 大角虫漫画 有妖气 知音漫客 咪咕 SF漫画 哦漫画 看漫画 漫画柜 汗汗酷漫 動漫伊甸園 快看漫画 微博动漫 733动漫网 大古漫画网 漫画DB 無限動漫 動漫狂 卡推漫画 动漫之家 动漫屋 古风漫画网 36漫画网 亲亲漫画网 乙女漫画 comico webtoons 咚漫 ニコニコ静画 ComicWalker ヤングエースUP モアイ pixivコミック サイコミ;アルファポリス カクヨム ハーメルン 小説家になろう 起点中文网 八一中文网 顶点小说 落霞小说网 努努书坊 笔趣阁→epub.
Stars: ✭ 1,224 (+786.96%)
Mutual labels:  epub
The Economist Ebooks
经济学人(含音频)、纽约客、自然、新科学人、卫报、科学美国人、连线、大西洋月刊、新闻周刊、国家地理等英语杂志免费下载、订阅(kindle推送),支持epub、mobi、pdf格式, 每周更新. The Economist 、The New Yorker 、Nature、The Atlantic 、New Scientist、The Guardian、Scientific American、Wired、Newsweek magazines, free download and subscription for kindle, mobi、epub、pdf format.
Stars: ✭ 3,471 (+2415.22%)
Mutual labels:  epub
You Dont Know Js Epub
"You Don't Know JS Yet" (2nd Edition) ePub generator.
Stars: ✭ 76 (-44.93%)
Mutual labels:  epub
R2 Testapp Swift
📖 An EPUB & CBZ reading app for iOS
Stars: ✭ 110 (-20.29%)
Mutual labels:  epub
Shirah Reader
RSVP speed reader, written in python.
Stars: ✭ 133 (-3.62%)
Mutual labels:  epub
Novel Grabber
Novel-Grabber can download novels from pretty much any webnovel and lightnovel site.
Stars: ✭ 125 (-9.42%)
Mutual labels:  epub
Architecture
📚 Documents the architecture of the Readium project
Stars: ✭ 118 (-14.49%)
Mutual labels:  epub

ePub Boilerplate

A simple template that helps you build ePub-formatted books.

How to use the template

  1. Clone the repo:

     $ git clone [email protected]:javierarce/epub-boilerplate.git
    
  2. Edit the contents of the book directory1.

  3. Run the publish script to generate and validate the book:

     $ ./publish book
    

1: You'll find comments inside several files to guide you.

Structure of a book

Here's the structure of the sample book included in the repo:

▾ book/
  ▾ META-INF/
      com.apple.ibooks.display-options.xml
      container.xml
  ▾ OEBPS/
    ▾ Images/
        cover.jpg
        image-01.jpg
        image-02.png
    ▾ Styles/
        style.css
    ▾ Text/
        acknowledgements.xhtml
        chapter01.xhtml
        chapter02.xhtml
        chapter03.xhtml
        cover.xhtml
        dedication.xhtml
        endnotes.xhtml
        foreword.xhtml
        frontmatter.xhtml
        introduction.xhtml
        toc.xhtml
      content.opf
      toc.ncx
    mimetype

ePub validation

This project uses epubcheck to validate the generated ePubs. If the build.sh script complains when running epubcheck, make sure you have java installed and it's in your PATH.

If you need help running epubcheck read this step-by-step guide.

How to check your ebook

It's super easy. Just do:

$ ./check book.epub

This project currently uses EpubCheck version 4.0.

Style

Caveat lector: currently there aren't any defined styles. While I add a basic layout have a look at the ePub CSS Starter Kit.

ePub → mobi

If you want to transform your .epub file to .mobi do this:

  1. Download KindleGen.
  2. Uncompress the file.
  3. Copy the kindlegen executable to the bin folder.
  4. Run ./bin/kindlegen book.epub.

Useful resources

EPUB 3

Metadata

Styling

Validation

Compatibility and rendering issues

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].