Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/futurepress/epub.js
Enhanced eBooks in the browser.
https://github.com/futurepress/epub.js
epub
Last synced: about 2 months ago
JSON representation
Enhanced eBooks in the browser.
- Host: GitHub
- URL: https://github.com/futurepress/epub.js
- Owner: futurepress
- License: other
- Created: 2012-10-27T16:07:37.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2024-07-26T08:36:29.000Z (about 2 months ago)
- Last Synced: 2024-07-28T11:08:54.772Z (about 2 months ago)
- Topics: epub
- Language: JavaScript
- Homepage: http://futurepress.org
- Size: 26.4 MB
- Stars: 6,328
- Watchers: 203
- Forks: 1,082
- Open Issues: 501
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
# Epub.js v0.3
Epub.js is a JavaScript library for rendering ePub documents in the browser, across many devices.
Epub.js provides an interface for common ebook functions (such as rendering, persistence and pagination) without the need to develop a dedicated application or plugin. Importantly, it has an incredibly permissive [Free BSD](http://en.wikipedia.org/wiki/BSD_licenses) license.
[Try it while reading Moby Dick](https://futurepress.github.io/epubjs-reader/)
## Why EPUB
The [EPUB standard](http://www.idpf.org/epub/30/spec/epub30-overview.html) is a widely used and easily convertible format. Many books are currently in this format, and it is convertible to many other formats (such as PDF, Mobi and iBooks).
An unzipped EPUB3 is a collection of HTML5 files, CSS, images and other media – just like any other website. However, it enforces a schema of book components, which allows us to render a book and its parts based on a controlled vocabulary.
More specifically, the EPUB schema standardizes the table of contents, provides a manifest that enables the caching of the entire book, and separates the storage of the content from how it’s displayed.
## Getting Started
If using archived `.epub` files include JSZip (this must precede inclusion of epub.js):
```html
```
Get the minified code from the build folder:
```html
```
Set up a element to render to:
```html
```
Create the new ePub, and then render it to that element:
```html
var book = ePub("url/to/book/package.opf");
var rendition = book.renderTo("area", {width: 600, height: 400});
var displayed = rendition.display();
```
## Render Methods
### Default
```js
book.renderTo("area", { method: "default", width: "100%", height: "100%" });
```
[View example](http://futurepress.github.io/epub.js/examples/spreads.html)
The default manager only displays a single section at a time.
### Continuous
```js
book.renderTo("area", { method: "continuous", width: "100%", height: "100%" });
```
[View example](http://futurepress.github.io/epub.js/examples/continuous-scrolled.html)
The continuous manager will display as many sections as need to fill the screen, and preload the next section offscreen. This enables seamless swiping / scrolling between pages on mobile and desktop, but is less performant than the default method.
## Flow Overrides
### Auto (Default)
`book.renderTo("area", { flow: "auto", width: "900", height: "600" });`
Flow will be based on the settings in the OPF, defaults to `paginated`.
### Paginated
```js
book.renderTo("area", { flow: "paginated", width: "900", height: "600" });
```
[View example](http://futurepress.github.io/epub.js/examples/spreads.html)
Scrolled: `book.renderTo("area", { flow: "scrolled-doc" });`
[View example](http://futurepress.github.io/epub.js/examples/scrolled.html)
## Scripted Content
[Scripted content](https://www.w3.org/TR/epub-33/#sec-scripted-content), JavasScript the ePub HTML content, is disabled by default due to the potential for executing malicious content.
This is done by sandboxing the iframe the content is rendered into, though it is still recommended to sanitize the ePub content server-side as well.
If a trusted ePub contains interactivity, it can be enabled by passing `allowScriptedContent: true` to the `Rendition` settings.
```html
var rendition = book.renderTo("area", {
width: 600,
height: 400,
allowScriptedContent: true
});
```
This will allow the sandboxed content to run scripts, but currently makes the sandbox insecure.
## Documentation
API documentation is available at [epubjs.org/documentation/0.3/](http://epubjs.org/documentation/0.3/)
A Markdown version is included in the repo at [documentation/API.md](https://github.com/futurepress/epub.js/blob/master/documentation/md/API.md)
## Running Locally
install [node.js](http://nodejs.org/)
Then install the project dependences with npm
```javascript
npm install
```
You can run the reader locally with the command
```javascript
npm start
```
## Examples
+ [Spreads](http://futurepress.github.io/epub.js/examples/spreads.html)
+ [Scrolled](http://futurepress.github.io/epub.js/examples/scrolled.html)
+ [Swipe](http://futurepress.github.io/epub.js/examples/swipe.html)
+ [Input](http://futurepress.github.io/epub.js/examples/input.html)
+ [Highlights](http://futurepress.github.io/epub.js/examples/highlights.html)
[View All Examples](http://futurepress.github.io/epub.js/examples/)
## Testing
Test can be run by Karma from NPM
```js
npm test
```
## Building for Distribution
Builds are concatenated and minified using [webpack](https://webpack.js.org/) and [babel](https://babeljs.io/)
To generate a new build run
```javascript
npm run prepare
```
or to continuously build run
```javascript
npm run watch
```
## Hooks
Similar to a plugins, Epub.js implements events that can be "hooked" into. Thus you can interact with and manipulate the contents of the book.
Examples of this functionality is loading videos from YouTube links before displaying a chapter's contents or implementing annotation.
Hooks require an event to register to and a can return a promise to block until they are finished.
Example hook:
```javascript
rendition.hooks.content.register(function(contents, view) {
var elements = contents.document.querySelectorAll('[video]');
var items = Array.prototype.slice.call(elements);
items.forEach(function(item){
// do something with the video item
});
})
```
The parts of the rendering process that can be hooked into are below.
```js
book.spine.hooks.serialize // Section is being converted to text
book.spine.hooks.content // Section has been loaded and parsed
rendition.hooks.render // Section is rendered to the screen
rendition.hooks.content // Section contents have been loaded
rendition.hooks.unloaded // Section contents are being unloaded
```
## Reader
The reader has moved to its own repo at: https://github.com/futurepress/epubjs-reader/
## Additional Resources
[](https://gitter.im/futurepress/epub.js "Gitter Chat")
[Epub.js Developer Mailing List](https://groups.google.com/forum/#!forum/epubjs)
IRC Server: freenode.net Channel: #epub.js
Follow us on twitter: @Epubjs
+ http://twitter.com/#!/Epubjs
## Other
EPUB is a registered trademark of the [IDPF](http://idpf.org/).