Skip to content

Commit

Permalink
Merge branch 'release/v1.1.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
satorumurmur committed May 10, 2020
2 parents 5c08499 + 105ef83 commit 9c7541d
Show file tree
Hide file tree
Showing 60 changed files with 5,087 additions and 4,497 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2014 Satoru MATSUSHIMA
Copyright (c) 2013 Satoru Matsushima

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
68 changes: 38 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ And you can embed it in other webpages (like YouTube videos).

### Spec.

* EPUB 3+ and 2 compliant. Supports both fixed-layout and reflowable books of various language.
* EPUB 3+ and 2 compliant. Supports both reflowable and fixed-layout books of various language.
* Made with JavaScript. Works compatibly with all major web browsers on various OS/devices.
* Open source software released under the MIT License.
* Free. Open source software released under the MIT License.



### Table of Contents

1. [How to Setup & Read/Publish EPUB Books](#how-to-setup--readpublish-epub-books) (for Users/Publishers)
1. [How to Setup & Read/Publish EPUB Books](#how-to-setup--readpublish-epub-books) (for Users/Publishers)
2. [How to Arrange Development Environment](#how-to-arrange-development-environment) (for Developers)
3. [License](#license)
4. [Special Thanks](#special-thanks)
5. [Supported and Sponsored by](#supported-and-sponsored-by)
5. [Supported by](#supported-by)



Expand All @@ -38,7 +38,7 @@ And you can embed it in other webpages (like YouTube videos).



How to Setup & Read/Publish EPUB Books
How to Setup & Read/Publish EPUB Books
--------------------------------------------------------------------------------------------------------------------------------

Bibi supports 3 ways to read/publish EPUB books:
Expand Down Expand Up @@ -124,6 +124,7 @@ If you want to terminate this feature, set "no" to "accept-files" in `bibi/prese




How to Arrange Development Environment
--------------------------------------------------------------------------------------------------------------------------------

Expand All @@ -144,8 +145,6 @@ How to Arrange Development Environment
2. $ `cd <the local repository>`
3. $ `npm install`

And files and folders are generated in `__dist` folder.



### How to Develop
Expand Down Expand Up @@ -183,9 +182,9 @@ If you want to modify them, please edit files in the `Source` column instead of

### How to Make a Ditribution Package

* $ `npm run make:distribution-package`
1. webpack generates production version of Bibi to `__dist` folder.
2. gulp generates zipped archive to `__archives` folder.
* $ `npm run make:package`
1. webpack generates temporary files of production version of Bibi.
2. gulp generates zipped archive to `__archives` folder. After that, the temporary files are removed.



Expand All @@ -197,31 +196,35 @@ License

### Bibi ([ja](https://bibi.epub.link) / [en](https://github.com/satorumurmur/bibi))

* Copyright &copy; [Satoru MATSUSHIMA](https://string-letters.com) ([@satorumurmur](https://twitter.com/satorumurmur))
* Licensed under [the MIT License](https://github.com/satorumurmur/bibi/blob/master/LICENSE).
* © [Satoru Matsushima](https://string-letters.com) ([@satorumurmur](https://twitter.com/satorumurmur))
* Open source under [the MIT License](https://github.com/satorumurmur/bibi/blob/master/LICENSE)



### Bibi is including and powered by these open source softwares:

* Core:
- [sML.js](https://github.com/satorumurmur/sML) ... Copyright &copy; Satoru MATSUSHIMA (Licensed under [the MIT License](https://github.com/satorumurmur/sML/blob/master/LICENSE).)
- [Material Icons](https://material.io/icons/) ... Copyright &copy; Material Design Authors / Google Inc. (Licensed under [the Apache License version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).)
- [sML.js](https://github.com/satorumurmur/sML) : © Satoru Matsushima / Licensed under [the MIT License](https://github.com/satorumurmur/sML/blob/master/LICENSE)
- [Material Icons](https://material.io/icons/) : © Material Design Authors &amp; Google Inc. / Licensed under [the Apache License version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html)
* Extensions:
- [Bibi Zip Loader](https://github.com/lunascape/bibi-zip-loader) ... Copyright &copy; Lunascape (Licensed under [the MIT License](https://github.com/lunascape/bibi-zip-loader/blob/master/LICENSE).)
- [JSZip](http://stuk.github.io/jszip) ... Copyright &copy; Stuart Knightley (Dual licensed under [the MIT License or the GPLv3](https://github.com/Stuk/jszip/blob/HEAD/LICENSE.markdown).)
- [JSZipUtils](http://stuk.github.io/jszip-utils) ... Copyright &copy; Stuart Knightley (Dual licensed under [the the MIT License or the GPLv3](https://github.com/Stuk/jszip-utils/blob/master/LICENSE.markdown).)
- [JS-YAML](http://nodeca.github.io/js-yaml/) ... Copyright &copy; Vitaly Puzrin (Licensed under [the MIT License](https://github.com/nodeca/js-yaml/blob/master/LICENSE).)
- [Bibi Zip Loader](https://github.com/lunascape/bibi-zip-loader) : © Lunascape / Licensed under [the MIT License](https://github.com/lunascape/bibi-zip-loader/blob/master/LICENSE)
- [JSZip](http://stuk.github.io/jszip) : © Stuart Knightley / Dual licensed under [the MIT License or the GPLv3](https://github.com/Stuk/jszip/blob/HEAD/LICENSE.markdown)
- [JSZipUtils](http://stuk.github.io/jszip-utils) : © Stuart Knightley / Dual licensed under [the MIT License or the GPLv3](https://github.com/Stuk/jszip-utils/blob/master/LICENSE.markdown)
- [JS-YAML](http://nodeca.github.io/js-yaml/) : © Vitaly Puzrin / Licensed under [the MIT License](https://github.com/nodeca/js-yaml/blob/master/LICENSE)
- [DOMPurify](https://github.com/cure53/DOMPurify) : © Mario Heiderich / Dual licensed under [the Apache License Version 2.0 or the Mozilla Public License Version 2.0](https://github.com/cure53/DOMPurify/blob/master/LICENSE)
* Polyfills:
- [classlist-polyfill](https://github.com/yola/classlist-polyfill) ... by Yola Inc. (Released into the public domain under [the Unlicense](https://github.com/yola/classlist-polyfill/blob/master/LICENSE))
- [text-encoding-utf-8](https://github.com/arv/text-encoding-utf-8) ... by Erik Arvidsson (Released into the public domain under [the Unlicense](https://github.com/arv/text-encoding-utf-8/blob/master/LICENSE.md).)
- [IntersectionObserver polyfill](https://github.com/w3c/IntersectionObserver) ... Copyright (c) W3C (Licensed under [the W3C Software and Document License](https://github.com/w3c/IntersectionObserver/blob/master/LICENSE.md).)
- [document.currentScript Polyfill](https://github.com/amiller-gh/currentScript-polyfill) ... Copyright &copy; Adam Miller (Licensed under [the MIT License](https://github.com/amiller-gh/currentScript-polyfill/blob/master/LICENSE).)
- [custom-event-polyfill](https://github.com/kumarharsh/custom-event-polyfill) ... Copyright &copy; Evan Krambuhl (Licensed under [the MIT License](https://github.com/kumarharsh/custom-event-polyfill/blob/master/LICENSE).)
- [Native Promise Only (NPO)](https://github.com/getify/native-promise-only) ... Copyright &copy; Kyle Simpson (Licensed under [the MIT License](http://getify.mit-license.org/).)
- [Polyfill Array.prototype.includes](https://github.com/latusinski/polyfill-array-includes) ... Copyright &copy; Kevin Latusinski (Licensed under [the MIT License](https://www.npmjs.com/package/polyfill-array-includes).)
- [String.prototype.padStart](https://github.com/KhaledElAnsari/String.prototype.padStart) ... Copyright &copy; Khaled Al-Ansari (Licensed under [the MIT License](https://github.com/KhaledElAnsari/String.prototype.padStart/blob/master/LICENSE).)
- [url-polyfill](https://github.com/lifaon74/url-polyfill) ... Copyright &copy; Valentin Richard (Licensed under [the MIT License](https://github.com/lifaon74/url-polyfill/blob/master/LICENSE).)
- [classlist-polyfill](https://github.com/yola/classlist-polyfill) : by Yola Inc. / Released into the public domain under [the Unlicense](https://github.com/yola/classlist-polyfill/blob/master/LICENSE)
- [text-encoding-utf-8](https://github.com/arv/text-encoding-utf-8) : by Erik Arvidsson / Released into the public domain under [the Unlicense](https://github.com/arv/text-encoding-utf-8/blob/master/LICENSE.md)
- [IntersectionObserver polyfill](https://github.com/w3c/IntersectionObserver) : © W3C / Licensed under [the W3C Software and Document License](https://github.com/w3c/IntersectionObserver/blob/master/LICENSE.md)
- [document.currentScript Polyfill](https://github.com/amiller-gh/currentScript-polyfill) : © Adam Miller / Licensed under [the MIT License](https://github.com/amiller-gh/currentScript-polyfill/blob/master/LICENSE)
- [custom-event-polyfill](https://github.com/kumarharsh/custom-event-polyfill) : © Evan Krambuhl / Licensed under [the MIT License](https://github.com/kumarharsh/custom-event-polyfill/blob/master/LICENSE)
- [Native Promise Only (NPO)](https://github.com/getify/native-promise-only) : © Kyle Simpson / Licensed under [the MIT License](http://getify.mit-license.org/)
- [ES6 Object.assign()](https://github.com/rubennorte/es6-object-assign) : © Rubén Norte / Licensed under [the MIT License](https://github.com/rubennorte/es6-object-assign/blob/master/LICENSE)
- [Polyfill Array.prototype.includes](https://github.com/latusinski/polyfill-array-includes) : © Kevin Latusinski / Licensed under [the MIT License](https://www.npmjs.com/package/polyfill-array-includes)
- [String.prototype.padStart](https://github.com/KhaledElAnsari/String.prototype.padStart) : © Khaled Al-Ansari / Licensed under [the MIT License](https://github.com/KhaledElAnsari/String.prototype.padStart/blob/master/LICENSE)
- [url-polyfill](https://github.com/lifaon74/url-polyfill) : © Valentin Richard / Licensed under [the MIT License](https://github.com/lifaon74/url-polyfill/blob/master/LICENSE)




Special Thanks
Expand All @@ -230,10 +233,15 @@ Special Thanks
Thanks to the contributors and the users around the world.


Supported and Sponsored by


Supported by
--------------------------------------------------------------------------------------------------------------------------------

### [Lunascape](https://lunascape.org)
### [Lunascape](https://www.lunascape.tv)

* Bibi v1.0.0 was developed with greateful support and sponsoring from [Lunascape](https://lunascape.org) (and their parent company [MEDIA DO Co.,Ltd.](https://mediado.jp/mediado) who absorbed and merged them).
* Bibi v1.0.0 was developed with greateful support and sponsoring from [Lunascape](https://www.lunascape.tv).
* Lunascape also developed [Bibi Zip Loader](https://github.com/lunascape/bibi-zip-loader) especially for Bibi, which realized fast progressive loading of zipped EPUBs.



Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops">
<head>
<title>Nav</title>
</head>
<body epub:type="frontmatter">
<header>
<h1>ToC</h1>
</header>
<nav epub:type="toc">
<ol>
<li><a href="p01.png">p.1</a></li>
</ol>
</nav>
<nav epub:type="page-list">
<ol>
<li><a href="p01.png">p.1</a></li>
<li><a href="p02.png">p.2</a></li>
<li><a href="p03.png">p.3</a></li>
<li><a href="p04.png">p.4</a></li>
<li><a href="p05.png">p.5</a></li>
<li><a href="p06.png">p.6</a></li>
</ol>
</nav>
</body>
</html>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<package xmlns="http://www.idpf.org/2007/opf" version="3.0" xml:lang="ja" prefix="rendition: http://www.idpf.org/vocab/rendition/#" unique-identifier="uid">
<metadata xmlns:opf="http://www.idpf.org/2007/opf" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcterms="http://purl.org/dc/terms/">
<dc:identifier id="uid">urn:uuid:C3171445-62C6-470B-814B-14D15745BA8E</dc:identifier>
<dc:title>Sample: Pre-Paginated LtR</dc:title>
<dc:language>ja-jp</dc:language>
<dc:creator>Bibi Lalalu</dc:creator>
<dc:publisher>bibi.epub.link</dc:publisher>
<meta property="dcterms:modified">2020-03-11T12:00:00Z</meta>
<meta property="rendition:layout">pre-paginated</meta>
<meta property="rendition:orientation">portrait</meta>
<meta property="rendition:spread">landscape</meta>
<meta name="original-resolution" content="1440x2000" />
<meta name="cover" content="cov" />
</metadata>
<manifest>
<item id="nav" media-type="application/xhtml+xml" href="nav.xhtml" properties="nav" />
<item id="cov" media-type="image/png" href="cov.png" properties="cover-image" />
<item id="p02" media-type="image/png" href="p02.png" />
<item id="p03" media-type="image/png" href="p03.png" />
<item id="p04" media-type="image/png" href="p04.png" />
<item id="p05" media-type="image/png" href="p05.png" />
<item id="p06" media-type="image/png" href="p06.png" />
<item id="p07" media-type="image/png" href="p07.png" />
</manifest>
<spine page-progression-direction="ltr">
<itemref idref="cov" properties="page-spread-center" />
<itemref idref="p02" properties="page-spread-right" />
<itemref idref="p03" properties="page-spread-left" />
<itemref idref="p04" properties="page-spread-right" />
<itemref idref="p05" properties="page-spread-left" />
<itemref idref="p06" properties="page-spread-right" />
<itemref idref="p07" properties="page-spread-left" />
</spine>
</package>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<container xmlns="urn:oasis:names:tc:opendocument:xmlns:container" version="1.0">
<rootfiles>
<rootfile full-path="CONTENT/package.opf" media-type="application/oebps-package+xml" />
</rootfiles>
</container>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
application/epub+zip
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops">
<head>
<title>Nav</title>
</head>
<body epub:type="frontmatter">
<header>
<h1>ToC</h1>
</header>
<nav epub:type="toc">
<ol>
<li><a href="p01.png">p.1</a></li>
</ol>
</nav>
<nav epub:type="page-list">
<ol>
<li><a href="p01.png">p.1</a></li>
<li><a href="p02.png">p.2</a></li>
<li><a href="p03.png">p.3</a></li>
<li><a href="p04.png">p.4</a></li>
<li><a href="p05.png">p.5</a></li>
<li><a href="p06.png">p.6</a></li>
</ol>
</nav>
</body>
</html>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<package xmlns="http://www.idpf.org/2007/opf" version="3.0" xml:lang="ja" prefix="rendition: http://www.idpf.org/vocab/rendition/#" unique-identifier="uid">
<metadata xmlns:opf="http://www.idpf.org/2007/opf" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcterms="http://purl.org/dc/terms/">
<dc:identifier id="uid">urn:uuid:D7F57A3B-8D31-4004-A5BF-543B40DA21E8</dc:identifier>
<dc:title>Sample: Pre-Paginated RtL</dc:title>
<dc:language>ja-jp</dc:language>
<dc:creator>Bibi Lalalu</dc:creator>
<dc:publisher>bibi.epub.link</dc:publisher>
<meta property="dcterms:modified">2020-03-11T12:00:00Z</meta>
<meta property="rendition:layout">pre-paginated</meta>
<meta property="rendition:orientation">portrait</meta>
<meta property="rendition:spread">landscape</meta>
<meta name="original-resolution" content="1440x2000" />
<meta name="cover" content="cov" />
</metadata>
<manifest>
<item id="nav" media-type="application/xhtml+xml" href="nav.xhtml" properties="nav" />
<item id="cov" media-type="image/png" href="cov.png" properties="cover-image" />
<item id="p02" media-type="image/png" href="p02.png" />
<item id="p03" media-type="image/png" href="p03.png" />
<item id="p04" media-type="image/png" href="p04.png" />
<item id="p05" media-type="image/png" href="p05.png" />
<item id="p06" media-type="image/png" href="p06.png" />
<item id="p07" media-type="image/png" href="p07.png" />
</manifest>
<spine page-progression-direction="rtl">
<itemref idref="cov" properties="page-spread-center" />
<itemref idref="p02" properties="page-spread-left" />
<itemref idref="p03" properties="page-spread-right" />
<itemref idref="p04" properties="page-spread-left" />
<itemref idref="p05" properties="page-spread-right" />
<itemref idref="p06" properties="page-spread-left" />
<itemref idref="p07" properties="page-spread-right" />
</spine>
</package>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<container xmlns="urn:oasis:names:tc:opendocument:xmlns:container" version="1.0">
<rootfiles>
<rootfile full-path="CONTENT/package.opf" media-type="application/oebps-package+xml" />
</rootfiles>
</container>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
application/epub+zip
Loading

0 comments on commit 9c7541d

Please sign in to comment.