yetangitu/epub.js
1
0
Fork 0
mirror of https://github.com/futurepress/epub.js.git synced 2025-10-05 15:32:55 +02:00
Code Issues Releases Wiki Activity

Merge with Master

Browse source
This commit is contained in:
Fred Chasen 2018-05-01 10:54:12 -07:00
commit 6e7d2d3b3c
1 changed files with 8 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -12,11 +12,11 @@ Epub.js provides an interface for common ebook functions (such as rendering, per
![Why EPUB](http://fchasen.com/futurepress/whyepub.png)
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).
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.
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.
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
@ -32,7 +32,7 @@ If using archived `.epub` files include JSZip:
<script src="https://cdnjs.cloudflare.com/ajax/libs/jszip/3.1.5/jszip.min.js"></script>
```
Setup a element to render to:
Set up a element to render to:
```html
<div id="area"></div>
@ -98,12 +98,13 @@ A Markdown version is included in the repo at [documentation/API.md](htts://gith
install [node.js](http://nodejs.org/)
install the project dependences with npm
Then install the project dependences with npm
```javascript
npm install
```
then you can run the reader locally with the command
You can run the reader locally with the command
```javascript
npm start
@ -147,7 +148,7 @@ npm run watch
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 chapters contents or implementing annotation.
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.