jekyll-ebook_reader 0.1.1 → 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e361e553631b855b813f001eb2d58d78bfb8c5752042a9316ea850146941b60d
4
- data.tar.gz: 82bd977ff5b759642f7e599f32f299b6e235641196226c97fd2ce11ea716e99b
3
+ metadata.gz: 4692ec8acd61d8c2318c34c6cb08faf2a1662ce34862b0591222626e3eba1a81
4
+ data.tar.gz: 5355ee367c7a3cdc4930892dbe9c97c874dc916d95bb3b4f064b8ed2c54d5320
5
5
  SHA512:
6
- metadata.gz: d52f0daa15ee8d4f89e6170eb61761d0b98d913fa5fe0489e41eda0d62f5d097968e0c5b53d31ebb2cb23551cd4b484b4ecd9c467ab3e828304a7e037d45fc3d
7
- data.tar.gz: d715edc681a9abac59d4e6291824ef3fb21071cc7a2b00e23e24db64321c62d35e8521b075f8299ea55d6328f987d79e6b6febfaddeb1da131f4430680d74175
6
+ metadata.gz: 9bd111ef50f338336c532cdcfd2aefe2178e80d1f9ea65a018ec0251bebb5abba766217c27ce73873047ec315f92fd9e5faf0b3d94a1bb33dfe80c7caa807b9a
7
+ data.tar.gz: d053273da061a078f4df8c67610cbc52477c226d406a9812c0654798bcec983e8e7bd8ce9e1c9f84bcc79973add8f997e2e1d160fee9247a4c0ed3b62d7815da
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- jekyll-ebook_reader (0.1.1)
4
+ jekyll-ebook_reader (0.1.3)
5
5
  fileutils (>= 1.1.0, <= 1.5.0)
6
6
  jekyll (>= 3.0, < 5.0)
7
7
 
@@ -90,11 +90,11 @@ PLATFORMS
90
90
  x86_64-darwin-18
91
91
 
92
92
  DEPENDENCIES
93
- bundler
93
+ bundler (>= 1.17.2, <= 2.2.12)
94
94
  jekyll-ebook_reader!
95
95
  rake (~> 13.0)
96
96
  rubocop (~> 1.7)
97
- rubocop-rake
97
+ rubocop-rake (>= 0.1.1, <= 0.5.1)
98
98
 
99
99
  BUNDLED WITH
100
- 2.2.9
100
+ 2.2.11
data/LICENSE.md ADDED
@@ -0,0 +1,57 @@
1
+ ## Main License
2
+
3
+ The MIT License (MIT)
4
+
5
+ Copyright (c) 2021 Quinn Batten
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in
15
+ all copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ THE SOFTWARE.
24
+
25
+ ## Included Related Software
26
+
27
+ Includes other software related under the MIT license:
28
+ - FuturePress hypothesis-reader, Copyright 2017 futurepress. See Futurepress License section below. This license applies to substantial portions of:
29
+ - lib/jekyll/ebook_reader/assets/jekyll-ebookreader-assets/ajax-loader.gif
30
+ - lib/jekyll/ebook_reader/assets/jekyll-ebookreader-assets/reader.js
31
+ - lib/jekyll/ebook_reader/assets/jekyll-ebookreader-assets/ebookreader_iframe.css
32
+
33
+ ---
34
+
35
+ ## Futurepress License
36
+
37
+ MIT License
38
+
39
+ Copyright (c) 2017 futurepress
40
+
41
+ Permission is hereby granted, free of charge, to any person obtaining a copy
42
+ of this software and associated documentation files (the "Software"), to deal
43
+ in the Software without restriction, including without limitation the rights
44
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
45
+ copies of the Software, and to permit persons to whom the Software is
46
+ furnished to do so, subject to the following conditions:
47
+
48
+ The above copyright notice and this permission notice shall be included in all
49
+ copies or substantial portions of the Software.
50
+
51
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
52
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
53
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
54
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
55
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
56
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
57
+ SOFTWARE.
data/LICENSE.txt CHANGED
@@ -1,21 +1 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2021 Quinn Batten
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.
1
+ See LICENSE.md.
data/README.md CHANGED
@@ -4,24 +4,36 @@ This plugin allows you to embed eBooks in your site on any page or post!
4
4
 
5
5
  It uses [EPUB.js](http://futurepress.org/) to do so.
6
6
 
7
+ You can see a [live demo here](https://www.quinnbatten.com/jekyll-ebook-reader-example.html) as well!
7
8
 
8
9
  ## Installation
9
10
 
10
- Add this line to your application's Gemfile:
11
+ You need to have Jekyll installed, of course, and have your Jekyll site all set up. If you haven't used plugins with Jekyll before, you should read [their docs on plugins](https://jekyllrb.com/docs/plugins/).
12
+
13
+ Add this line to your site's Gemfile:
11
14
 
12
15
  ```ruby
13
16
  gem 'jekyll-ebook_reader'
14
17
  ```
15
18
 
19
+ Then, go to your _config.yml, and addthe following (of course if you have a plugins item, just append the ebookreader line to it.)
20
+
21
+ ```yaml
22
+ plugins:
23
+ - jekyll/ebook_reader
24
+ ```
25
+
26
+ *BIG IMPORTANT NOTE:* Make sure you insert that exact line! It's not `- jekyll-ebook_reader`, nor is it `- ebook_reader`, those won't work.
27
+
16
28
  And then execute:
17
29
 
18
30
  $ bundle install
19
31
 
20
- Or install it yourself as:
32
+ Now you should be good to go!
21
33
 
22
- $ gem install jekyll-ebook_reader
34
+ # Usage
23
35
 
24
- ## Usage
36
+ ## Quickstart
25
37
 
26
38
  To embed a book on a page/post:
27
39
  1. Add your ebook file to your `/assets` folder. Take note of the path to your book, starting at the base of your site. (E.g. it may be '/assets/myBook.epub', or if you put it inside an "ebooks" subfolder, it might be 'assets/ebooks/myBook.epub'.)
@@ -47,17 +59,11 @@ Gosh this is my favorite book!!
47
59
  ```
48
60
 
49
61
 
62
+ ## Troubleshooting & Contributing
50
63
 
51
- ## Development
52
-
53
- After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
54
-
55
- To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
56
-
57
- ## Contributing
64
+ Bug reports and pull requests are welcome on GitHub at [github.com/qbatten/jekyll-ebook_reader](https://github.com/qbatten/jekyll-ebook_reader).
58
65
 
59
- Bug reports and pull requests are welcome on GitHub at https://github.com/qbatten/jekyll-ebook_reader.
66
+ ## Acknowledgments
60
67
 
61
- ## License
68
+ EPUB.js is an awesome library and you should check them out! This plugin is really just a simple wrapper around their hypothesis-reader library that makes it easy to use with Jekyll. The JavaScript code used here is based closely on epubjs's demo code, with some small changes made for aesthetics and compatibility with the layout I chose. See LICENSE.md for details on licensing.
62
69
 
63
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
@@ -0,0 +1,7 @@
1
+ To deploy:
2
+
3
+ ```
4
+ export tmp_jekyll_ebook_gem_version=0.1.2
5
+ gem build jekyll-ebook_reader.gemspec
6
+ gem push jekyll-ebook_reader-${tmp_jekyll_ebook_gem_version}.gem
7
+ ```
@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
9
9
  spec.email = ["quinnbatten@mac.com"]
10
10
 
11
11
  spec.summary = "Plugin to embed ebooks in your site."
12
- spec.description = "EbookReader uses ePub.js to embed ebooks on any page or post you like."
13
- spec.homepage = "https://www.quinnbatten.com/jekyllebookreader.html"
12
+ spec.description = "Easily embed ebooks on any page or post in your Jekyll site. See the README for detailed installation and usage info: https://github.com/qbatten/jekyll-ebook_reader"
13
+ spec.homepage = "https://github.com/qbatten/jekyll-ebook_reader"
14
14
  spec.license = "MIT"
15
15
  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
16
16
 
@@ -30,6 +30,6 @@ Gem::Specification.new do |spec|
30
30
  spec.add_dependency "fileutils", ">= 1.1.0", "<= 1.5.0"
31
31
  spec.add_dependency "jekyll", ">= 3.0", "< 5.0"
32
32
 
33
- spec.add_development_dependency "bundler"
34
- spec.add_development_dependency "rubocop-rake"
33
+ spec.add_development_dependency "bundler", ">= 1.17.2", "<= 2.2.12"
34
+ spec.add_development_dependency "rubocop-rake", ">=0.1.1", "<= 0.5.1"
35
35
  end
@@ -1,17 +1,17 @@
1
1
  <div id="ebook-includes">
2
2
  <script type="text/javascript">
3
- let ebookPath = "{{page.ebook.ebook_path}}" || "{{page.ebook_path}}";
4
- let style_path = "{{page.ebook_iframe_custom_stylesheet}}" || "/assets/jekyll-ebookreader-assets/ebookreader_iframe.css"
5
- let eBookRenderOptions = {
3
+ var ebookPath = "{{page.ebook.ebook_path}}" || "{{page.ebook_path}}";
4
+ var style_path = "{{page.ebook_iframe_custom_stylesheet}}" || "/assets/jekyll-ebookreader-assets/ebookreader_iframe.css";
5
+ var eBookRenderOptions = {
6
6
  flow: "scrolled-doc",
7
7
  ignoreClass: "annotator-hl",
8
8
  width: "100%",
9
9
  height: "100%",
10
10
  stylesheet: style_path
11
- }
11
+ };
12
12
  document.addEventListener(
13
13
  'DOMContentLoaded',
14
- () => launchEpubJS(ebookPath, eBookRenderOptions),
14
+ function(){launchEpubJS(ebookPath, eBookRenderOptions)},
15
15
  false);
16
16
  </script>
17
17
  <a id="opener">
@@ -34,7 +34,7 @@
34
34
  <i class="material-icons">close</i>
35
35
  </a>
36
36
  <h1 id="title">...</h1>
37
- <image id="cover" width="150px" />
37
+ <image id="cover" width="150px" alt="cover_image" />
38
38
  <h2 id="author">...</h2>
39
39
  <ul id="toc"></ul>
40
40
  </div>
@@ -1,3 +1,3 @@
1
1
  <script src="https://cdnjs.cloudflare.com/ajax/libs/jszip/3.1.5/jszip.min.js"></script><script src="https://cdn.jsdelivr.net/npm/epubjs/dist/epub.min.js"></script><link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet" />
2
- <link rel="stylesheet" type="text/css" href="/assets/jekyll-ebookreader-assets/ebookreader_main.css">
2
+ <link rel="stylesheet" href="/assets/jekyll-ebookreader-assets/ebookreader_main.css">
3
3
  <script src="/assets/jekyll-ebookreader-assets/reader.js"></script>
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Jekyll
4
4
  module EbookReader
5
- VERSION = "0.1.1"
5
+ VERSION = "0.1.3"
6
6
  end
7
7
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-ebook_reader
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Quinn Batten
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2021-02-13 00:00:00.000000000 Z
11
+ date: 2021-02-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: fileutils
@@ -56,29 +56,42 @@ dependencies:
56
56
  requirements:
57
57
  - - ">="
58
58
  - !ruby/object:Gem::Version
59
- version: '0'
59
+ version: 1.17.2
60
+ - - "<="
61
+ - !ruby/object:Gem::Version
62
+ version: 2.2.12
60
63
  type: :development
61
64
  prerelease: false
62
65
  version_requirements: !ruby/object:Gem::Requirement
63
66
  requirements:
64
67
  - - ">="
65
68
  - !ruby/object:Gem::Version
66
- version: '0'
69
+ version: 1.17.2
70
+ - - "<="
71
+ - !ruby/object:Gem::Version
72
+ version: 2.2.12
67
73
  - !ruby/object:Gem::Dependency
68
74
  name: rubocop-rake
69
75
  requirement: !ruby/object:Gem::Requirement
70
76
  requirements:
71
77
  - - ">="
72
78
  - !ruby/object:Gem::Version
73
- version: '0'
79
+ version: 0.1.1
80
+ - - "<="
81
+ - !ruby/object:Gem::Version
82
+ version: 0.5.1
74
83
  type: :development
75
84
  prerelease: false
76
85
  version_requirements: !ruby/object:Gem::Requirement
77
86
  requirements:
78
87
  - - ">="
79
88
  - !ruby/object:Gem::Version
80
- version: '0'
81
- description: EbookReader uses ePub.js to embed ebooks on any page or post you like.
89
+ version: 0.1.1
90
+ - - "<="
91
+ - !ruby/object:Gem::Version
92
+ version: 0.5.1
93
+ description: 'Easily embed ebooks on any page or post in your Jekyll site. See the
94
+ README for detailed installation and usage info: https://github.com/qbatten/jekyll-ebook_reader'
82
95
  email:
83
96
  - quinnbatten@mac.com
84
97
  executables: []
@@ -91,11 +104,13 @@ files:
91
104
  - CHANGELOG.md
92
105
  - Gemfile
93
106
  - Gemfile.lock
107
+ - LICENSE.md
94
108
  - LICENSE.txt
95
109
  - README.md
96
110
  - Rakefile
97
111
  - bin/console
98
112
  - bin/setup
113
+ - developer_notes.md
99
114
  - jekyll-ebook_reader.gemspec
100
115
  - lib/jekyll/ebook_reader.rb
101
116
  - lib/jekyll/ebook_reader/assets/jekyll-ebookreader-assets/ajax-loader.gif
@@ -105,11 +120,11 @@ files:
105
120
  - lib/jekyll/ebook_reader/assets/jekyll-ebookreader-assets/ebookreader_main.css
106
121
  - lib/jekyll/ebook_reader/assets/jekyll-ebookreader-assets/reader.js
107
122
  - lib/jekyll/ebook_reader/version.rb
108
- homepage: https://www.quinnbatten.com/jekyllebookreader.html
123
+ homepage: https://github.com/qbatten/jekyll-ebook_reader
109
124
  licenses:
110
125
  - MIT
111
126
  metadata:
112
- homepage_uri: https://www.quinnbatten.com/jekyllebookreader.html
127
+ homepage_uri: https://github.com/qbatten/jekyll-ebook_reader
113
128
  source_code_uri: https://github.com/qbatten/jekyll-ebook_reader.git
114
129
  changelog_uri: https://github.com/qbatten/jekyll-ebook_reader/blob/main/CHANGELOG.md
115
130
  post_install_message: