All Projects → readium → Readium Cfi Js

readium / Readium Cfi Js

Licence: bsd-3-clause

Programming Languages

javascript
184084 projects - #8 most used programming language

Labels

Projects that are alternatives of or similar to Readium Cfi Js

Koodo Reader
A modern ebook manager and reader with sync and backup capacities for Windows, macOS, Linux and Web
Stars: ✭ 2,938 (+6895.24%)
Mutual labels:  epub
Pymupdf
Python bindings for MuPDF's rendering library.
Stars: ✭ 898 (+2038.1%)
Mutual labels:  epub
Readimension
eBook server supporting ePub and Authentication
Stars: ✭ 29 (-30.95%)
Mutual labels:  epub
Epr
CLI Epub Reader
Stars: ✭ 657 (+1464.29%)
Mutual labels:  epub
Ethereum Development With Go Book
📖 A little book on Ethereum Development with Go (golang)
Stars: ✭ 754 (+1695.24%)
Mutual labels:  epub
Ebreader
A minimal Ebook reader for Android/IOS made with flutter.
Stars: ✭ 25 (-40.48%)
Mutual labels:  epub
Plato
Document reader
Stars: ✭ 473 (+1026.19%)
Mutual labels:  epub
Publ Cg
EPUB 3 Community Group Repository
Stars: ✭ 40 (-4.76%)
Mutual labels:  epub
Booktype
Booktype is a free, open source platform that produces beautiful, engaging books formatted for print, Amazon, iBooks and almost any ereader within minutes.
Stars: ✭ 810 (+1828.57%)
Mutual labels:  epub
Mangareader To Ebook
download mangareader and make epub
Stars: ✭ 12 (-71.43%)
Mutual labels:  epub
Leanify
lightweight lossless file minifier/optimizer
Stars: ✭ 694 (+1552.38%)
Mutual labels:  epub
Ebooklib
Python E-book library for handling books in EPUB2/EPUB3 format -
Stars: ✭ 745 (+1673.81%)
Mutual labels:  epub
Quran Epub
Al Qur'an Terjemah Bahasa Indonesia
Stars: ✭ 10 (-76.19%)
Mutual labels:  epub
Google Sre Ebook
Google SRE Book Generator (EPUB/MOBI/PDF).
Stars: ✭ 578 (+1276.19%)
Mutual labels:  epub
Save As Ebook
Save a web page/selection as an eBook (.epub format) - a Chrome/Firefox/Opera Web Extension
Stars: ✭ 959 (+2183.33%)
Mutual labels:  epub
Calibre Web
📚 Web app for browsing, reading and downloading eBooks stored in a Calibre database
Stars: ✭ 5,616 (+13271.43%)
Mutual labels:  epub
Readteractive
Tool for writing and generating interactive books.
Stars: ✭ 23 (-45.24%)
Mutual labels:  epub
Rest Epub
Roy Fielding's REST dissertation in .epub
Stars: ✭ 40 (-4.76%)
Mutual labels:  epub
Readingcloud
An ebook reader written in Rails.
Stars: ✭ 33 (-21.43%)
Mutual labels:  epub
Netkiller.github.io
Netkiller Free ebook - 免费电子书
Stars: ✭ 861 (+1950%)
Mutual labels:  epub

readium-cfi-js

EPUB3 CFI utility library in JavaScript

This is a software component used by other Readium projects, see https://github.com/readium/readium-shared-js

License

BSD-3-Clause ( http://opensource.org/licenses/BSD-3-Clause )

See license.txt.

Installation

Using npm / yarn

npm install readium-cfi-js or yarn add readium-cfi-js

Importing

This library is bundled in UMD and ES module formats.

  • CommonJS
const EPUBcfi = require('readium-cfi-js');
  • ES Module
import * as EPUBcfi from 'readium-cfi-js';
  • Globally with window.EPUBcfi
<script src="readium-cfi.umd.js"></script>

Usage in non-browser environments (Node)

Currently not supported as the implementation depends on jQuery and the DOM.

A subset of the API could work without a browser, which may be planned for a future release.

Development

Prerequisites:

Initial setup:

  • npm install (to download dependencies defined in package.json ... note that the --production option can be used to avoid downloading development dependencies, for example when testing only the pre-built dist folder contents)

Typical workflow:

  • Hack away! (mostly the source code in ./src and ./spec/models )
  • npm run build (to update the output bundles in the dist folder)

Unit tests:

  • npm run test (Karma launcher)

Travis (Continuous Integration): https://travis-ci.org/readium/readium-cfi-js/

Bundled outputs

The dist directory contains bundled scripts in two module formats:

UMD - Universal Module Definition

readium-cfi.umd.js (and its associated source-map file), which aggregates all the required code (external library dependencies included, such as jQuery, etc.)

You can include this as CommonJS/AMD or with the global EPUBcfi

Works best for when using Browserify or RequireJS

ES Modules

readium-cfi.esm.js (and its associated source-map file), also aggregates all the required code

Works best for rollup.js or webpack

NPM package

All packages "owned" and maintained by the Readium Foundation are listed here: https://www.npmjs.com/~readium

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].