quiet-comic 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (40) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -23
  3. data/_config.yml +153 -0
  4. data/bin/quiet-comic-setup +75 -0
  5. data/{_artworks → setup_files/_artworks}/demo-0.md +0 -0
  6. data/{_artworks → setup_files/_artworks}/demo-1.md +0 -0
  7. data/{_artworks → setup_files/_artworks}/demo-2.md +0 -0
  8. data/{_artworks → setup_files/_artworks}/demo-3.md +0 -0
  9. data/{_artworks → setup_files/_artworks}/demo-4.md +0 -0
  10. data/{_artworks → setup_files/_artworks}/demo-5.md +0 -0
  11. data/{_artworks → setup_files/_artworks}/demo-6.md +0 -0
  12. data/{_artworks → setup_files/_artworks}/demo-7.md +0 -0
  13. data/{_artworks → setup_files/_artworks}/demo-8.md +0 -0
  14. data/{_artworks → setup_files/_artworks}/demo-9.md +0 -0
  15. data/{_artworks → setup_files/_artworks}/demo.md +0 -0
  16. data/{_pages → setup_files/_pages}/demo-0.md +0 -0
  17. data/{_pages → setup_files/_pages}/demo-1.md +0 -0
  18. data/{_pages → setup_files/_pages}/demo-2.md +0 -0
  19. data/{_pages → setup_files/_pages}/demo-3.md +0 -0
  20. data/{_pages → setup_files/_pages}/demo-4.md +0 -0
  21. data/{_pages → setup_files/_pages}/demo-5.md +0 -0
  22. data/{_pages → setup_files/_pages}/demo-6.md +0 -0
  23. data/{_pages → setup_files/_pages}/demo-7.md +0 -0
  24. data/{_pages → setup_files/_pages}/demo-8.md +0 -0
  25. data/{_pages → setup_files/_pages}/demo-9.md +0 -0
  26. data/{_pages → setup_files/_pages}/demo.md +0 -0
  27. data/{assets → setup_files/assets}/fonts/GloriaHallelujah.ttf +0 -0
  28. data/{assets → setup_files/assets}/fonts/PermanentMarker.ttf +0 -0
  29. data/{assets → setup_files/assets}/images/artworks/krita.jpg +0 -0
  30. data/{assets → setup_files/assets}/images/da-icon.svg +0 -0
  31. data/{assets → setup_files/assets}/images/fb-icon.svg +0 -0
  32. data/{assets → setup_files/assets}/images/feed-icon.svg +0 -0
  33. data/{assets → setup_files/assets}/images/github-icon.svg +0 -0
  34. data/{assets → setup_files/assets}/images/instagram-icon.svg +0 -0
  35. data/{assets → setup_files/assets}/images/pages/placeholder-page.jpg +0 -0
  36. data/{assets → setup_files/assets}/images/placeholder-brand-image.png +0 -0
  37. data/{assets → setup_files/assets}/images/twitter-icon.svg +0 -0
  38. data/{assets → setup_files/assets}/images/youtube-icon.svg +0 -0
  39. data/{assets → setup_files/assets}/main.scss +0 -0
  40. metadata +41 -38
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: eabe6236b5c7862fc79efe56bd0f4700c99a0760
4
- data.tar.gz: c1ccf6c90b2f96f948122537117eebde1f1d947c
3
+ metadata.gz: c5889401544a965316af6f79831c87693ee97a7c
4
+ data.tar.gz: 861977616ff08d88ac5c2c91571d3b4b91addcf4
5
5
  SHA512:
6
- metadata.gz: 1176c6d72c5e08b961d47c3ee42f9993803f57281cede3660c41895f7e4487f0cebade5aaca47792ebb97a72a3ac8992e244b0b85a6b9fc9de4a37e469346661
7
- data.tar.gz: b23490c3a7e6056c2157fa13ab88464caeefc2d4f1f9aecaf59962379057aeb3e27301b1ccc2f788dae6904f30ee69a500f02b4f968059b1d1f0903dd8d2931e
6
+ metadata.gz: c4d2771a6dd05026cc7beff5fa1ddb68992b957809b19ba1440b83c20a9a19b0bbbada40c6d1f08047979df1734c87b537e7b930e037160d2324c05618b07cf7
7
+ data.tar.gz: ee8d45719d2ae54401830374746f7771159b6d4aea13c03f0c1c81fa39bfa7ab12519ba132026fb72c7394979d104642c672d340f643574612c811b05dca7cdf
data/README.md CHANGED
@@ -22,29 +22,26 @@ Or install it yourself as:
22
22
 
23
23
  ### Getting Started
24
24
 
25
- #### Base Config
26
- If you haven't already, copy the [theme's default `_config.yml`](https://github.com/tjjjwxzq/quiet-comic/blob/master/_config.yml) into your Jekyll site's `_config.yml`.
25
+ This gem ships with a start-up script that copies over the following files and folders into your project directory:
27
26
 
28
- #### Collection folders
29
- Next, you'll need create a `_pages` and `_artworks` folder for your collection of comic pages and related artworks. You can copy the `_artworks` and `_pages` folder from the theme's source (it comes with some demo content). To locate where the theme gem is installed on your system, you can do
27
+ ```
28
+ +- _config.yml
29
+ +- _pages/
30
+ +- _artworks/
31
+ +- assets/
32
+ +- pages_feed.xml
33
+ +- artworks_feed.xml
34
+ +- combined_feed.xml
35
+ ```
36
+ To run the script:
30
37
 
31
38
  ```bash
32
- bundle show quiet-comic
39
+ bundle exec quiet-comic-setup
33
40
  ```
34
41
 
35
- in your project directory.
36
-
37
- If you run your website now you should be able to visit all the basic pages without any 404 errors.
38
-
39
- #### Image Thumbnails
40
- The asset files (images, fonts, stylesheets) from the theme are included implicitly. However, at this point, you will not be able to see the thumbnail images for the pages and the artworks (if you visit the `/pages` and `/artworks` page). The reason is that this theme uses `jekyll-minimagick` to generate thumbnails, but `jekyll-minimagick` only searches the `assets` directory of *your* project directory to generate the thumbnails, not the gem theme's.
41
-
42
- So for the thumbnails to show up properly, you should create an `assets/images/artworks` and `assets/images/pages` directory, and put in your desired images. (Again, you can copy the demo images from the gem source).
43
-
44
- #### Feed templates
45
- Unfortunately there is as yet no way to implicitly include files from gem-based themes other than the `_layouts`, `_includes`, `_sass` and `assets` directories (and thus also no way to update them cleanly through the gem system). So you have to do some manual work to set up feeds for your comic pages and artworks.
42
+ This will give you a base config file to work out from, the necessary folders (with demo files) for your pages and artworks collection, some demo images in `assets` so you can see thumbnail generation (with `jekyll-minimagick`) in action, and the feed templates jekyll requires to build a pages, artworks, and combined feed.
46
43
 
47
- Just copy the [theme's `pages_feed.xml`](https://github.com/tjjjwxzq/quiet-comic/blob/master/pages_feed.xml) into a `pages_feed.xml` file in your root directory, the [theme's `artworks_feed.xml`](https://github.com/tjjjwxzq/quiet-comic/blob/master/artworks_feed.xml) into a `artworks_feed.xml` file in your root directory, and the [theme's `combined_feed.xml`](https://github.com/tjjjwxzq/quiet-comic/blob/master/combined_feed.xml) into a `combined_feed.xml` file in your root directory. Then jekyll should generate all the feed files correctly, and include their links in your site `<head></head>`.
44
+ You probably only want to run this script on a fresh project, because it may override any existing files and folders with the same name, that you may have modified/worked on, if you let it. But the script will prompt you before copying each file, so you can feel free to skip some files while copying over others, should you want to 'reset' any file after messing something up.
48
45
 
49
46
  ### Configuration
50
47
  Please copy and paste the [theme's default `_config.yml` file](https://github.com/tjjjwxzq/quiet-comic/blob/master/_config.yml) into your own and customize any of the variables you wish.
@@ -186,12 +183,12 @@ When your theme is released, only the files in `_layouts`, `_includes`, `_sass`
186
183
  To add a custom directory to your theme-gem, please edit the regexp in `quiet-comic.gemspec` accordingly.
187
184
 
188
185
  ### TODO
189
- 1. Figure out image thumbnails in feed
190
- 3. Test-run the theme and check which should be spec files
191
- 5. Home page illustration and six simple comic pages
192
- 6. One simple artwork
193
- 7. Support grouping pages into chapters
194
- 8. Write a setup script
186
+ - [X] Write a setup script
187
+ - [] Figure out image thumbnails in feed
188
+ - [] Home page illustration
189
+ - [] Six Comic pages
190
+ - [] One artwork
191
+ - [] Support grouping pages into chapters
195
192
 
196
193
  ## License
197
194
 
@@ -0,0 +1,153 @@
1
+ # Welcome to Jekyll!
2
+ #
3
+ # This config file is meant for settings that affect your entire site, values
4
+ # which you are expected to set up once and rarely need to edit after that.
5
+ # For technical reasons, this file is *NOT* reloaded automatically when you use
6
+ # `jekyll serve`. If you change this file, please restart the server process.
7
+
8
+ # Site Settings
9
+ locale: "en"
10
+ title: "My quiet webcomic"
11
+ name: "Your Name"
12
+ description: "A quiet webcomic"
13
+ url: # the base hostname and protocol (eg. http://example.com)
14
+ baseurl: # the subpath of your site eg. /mycomic
15
+ repository: # Github username/repo-name
16
+ brand_image: "assets/images/placeholder-brand-image.png" # path to brand image in the `assets/images` folder
17
+ base_image_dir: "assets/images/" # default image directory. Ensure the trailing slash is there
18
+ thumbnail_label: "page_number" # either "title" or "page_number"
19
+ feed_label: "page_number" # either "title" or "page_number"
20
+
21
+ # SEO
22
+ # Social sharing
23
+ twitter:
24
+ username:
25
+ facebook:
26
+ username:
27
+ app_id:
28
+ publisher:
29
+ og_image: # path to default Open Graph site image for SEO (relative to base_image_dir)
30
+ # For specifying social profiles
31
+ # - https://developers.google.com/structured-data/customize/social-profiles
32
+ social:
33
+ type : # Person or Organization (defaults to Person)
34
+ name : # If the user or organization name differs from the site's name
35
+ links: # An array of links to social media profiles
36
+
37
+ # these go into the meta site verification tag that allows use of webmaster tools provided by the respective search engines
38
+ google-site-verification: # Google search engine
39
+ bing-site-verification: # Bing search engine
40
+ alexa-site-verification: # Alexa (Amazon) search engine
41
+ yandex-site-verification: # Yandex (Russia) search engine
42
+ naver-site-verification: # Naver (Korea) search engine
43
+ baidu-site-verification: # Baidu (China) search engine
44
+
45
+ # Analytics
46
+ google_analytics: # your google analytics tracking code
47
+ # https://analytics.google.com/analytics/web/provision/?authuser=0#provision/SignUp/
48
+
49
+ comments:
50
+ facebook:
51
+ # https://developers.facebook.com/docs/plugins/comments
52
+ num_posts: # 5 (default)
53
+ colorscheme: # "light" (default), "dark"
54
+
55
+ # Site author
56
+ author:
57
+ name: "Your Name"
58
+ bio: "I quietly create beautiful things"
59
+ email:
60
+ uri: # link to your home page
61
+ # linkes to your social media sites
62
+ deviant_art: "deviantart.com"
63
+ facebook: "facebook.com"
64
+ github: "github.com"
65
+ instagram: "instagram.com"
66
+ twitter: "twitter.com"
67
+ youtube: "youtube.com"
68
+
69
+ # Collections
70
+ collections:
71
+ pages:
72
+ output: true
73
+ permalink: /:collection/:path/ # trailing slash is necessary for current version of jekyll to serve pages correctly in development
74
+ layout: default
75
+ artworks:
76
+ output: true
77
+ permalink: /:collection/:path/
78
+ layout: default
79
+
80
+ # theme
81
+ theme: quiet-comic
82
+
83
+ # Markdown Processing
84
+ markdown: kramdown
85
+ highlighter: rouge
86
+ kramdown:
87
+ input: GFM
88
+
89
+ # Sass
90
+ sass:
91
+ sass_dir: _sass
92
+ style: compressed
93
+
94
+
95
+ # Plugins
96
+ plugins:
97
+ - jekyll-paginate-v2
98
+ - jekyll-sitemap
99
+ - jekyll-feed
100
+ - jekyll-minimagick
101
+ - jekyll-last-modified-at
102
+ - jemoji
103
+
104
+ # Defaults
105
+ defaults:
106
+ # comic pages
107
+ -
108
+ scope:
109
+ path: ""
110
+ type: "pages"
111
+ values:
112
+ layout: "page"
113
+ # artworks
114
+ -
115
+ scope:
116
+ path: ""
117
+ type: "artworks"
118
+ values:
119
+ layout: "artwork"
120
+
121
+ # jekyll-minimagick config
122
+ mini_magick:
123
+ pages_thumbnails:
124
+ source: "assets/images/pages"
125
+ destination: "assets/images/pages/thumbnails"
126
+ crop: "300x300+50+50"
127
+ artworks_thumbnails:
128
+ source: "assets/images/artworks"
129
+ destination: "assets/images/artworks/thumbnails"
130
+ crop: "300x300+50+50"
131
+
132
+ # jekyll-paginate-v2 config
133
+ autopages:
134
+ enabled: true
135
+ collections:
136
+ enabled: true
137
+ title: ':coll'
138
+ permalink: "/:coll/"
139
+ layouts:
140
+ - autopage_collection.html
141
+
142
+ pagination:
143
+ enabled: true
144
+ debug: true
145
+ per_page: 5
146
+ permalink: '/:num/'
147
+ title: ':title | :num of :max'
148
+ limit: 0
149
+ sort_field: 'page_number'
150
+ sort_reverse: true
151
+ trail:
152
+ before: 2
153
+ after: 2
@@ -0,0 +1,75 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'fileutils'
4
+
5
+ puts <<-EOS
6
+ Running this setup script will copy over the following files and folders
7
+ to your project directory and override them if they already exist:
8
+ 1. _config.yml
9
+ 2. _pages/
10
+ 3. _artworks/
11
+ 4. assets/
12
+ 5. pages_feed.xml
13
+ 6. artworks_feed.xml
14
+ 7. combined_feed.xml
15
+
16
+ You will be prompted before each file is copied over.
17
+ To opt out of copying over and possibly overriding the file, hit 'N'
18
+
19
+ EOS
20
+
21
+ spec = Gem::Specification.find_by_name('quiet-comic')
22
+ gem_root = spec.gem_dir
23
+
24
+ NO_STRINGS = %w[No no N n].freeze
25
+
26
+ puts 'Are you sure you want to copy over `_config.yml` (Y/N)?'
27
+ response = gets.chomp
28
+ unless NO_STRINGS.include?(response)
29
+ puts 'Copying base theme `_config.yml...`'
30
+ FileUtils.cp(File.join(gem_root, '_config.yml'), '.')
31
+ end
32
+ puts ''
33
+
34
+ puts 'Collection folders...'
35
+ puts 'Are you sure you want to copy over `_pages` (Y/N)?'
36
+ response = gets.chomp
37
+ unless NO_STRINGS.include?(response)
38
+ puts '1. Copying over `_pages...`'
39
+ FileUtils.cp_r(File.join(gem_root, 'setup_files', '_pages'), '.')
40
+ end
41
+ puts 'Are you sure you want to copy over `_artworks` (Y/N)?'
42
+ response = gets.chomp
43
+ unless NO_STRINGS.include?(response)
44
+ puts '2. Copying over `_artworks...`'
45
+ FileUtils.cp_r(File.join(gem_root, 'setup_files', '_artworks'), '.')
46
+ end
47
+ puts ''
48
+
49
+ puts 'Are you sure you want to copy over `assets` (Y/N)?'
50
+ response = gets.chomp
51
+ unless NO_STRINGS.include?(response)
52
+ puts 'Copying over `assets`...'
53
+ FileUtils.cp_r(File.join(gem_root, 'setup_files', 'assets'), '.')
54
+ end
55
+ puts ''
56
+
57
+ puts 'Feed templates...'
58
+ puts 'Are you sure you want to copy over `pages_feed.xml (Y/N)?`'
59
+ response = gets.chomp
60
+ unless NO_STRINGS.include?(response)
61
+ puts '1. Copying over `pages_feed.xml...`'
62
+ FileUtils.cp(File.join(gem_root, 'pages_feed.xml'), '.')
63
+ end
64
+ puts 'Are you sure you want to copy over `artworks_feed.xml (Y/N)?`'
65
+ response = gets.chomp
66
+ unless NO_STRINGS.include?(response)
67
+ puts '2. Copying over `artworks_feed.xml...`'
68
+ FileUtils.cp(File.join(gem_root, 'artworks_feed.xml'), '.')
69
+ end
70
+ puts 'Are you sure you want to copy over `combined_feed.xml (Y/N)?`'
71
+ response = gets.chomp
72
+ unless NO_STRINGS.include?(response)
73
+ puts '3. Copying over `combined_feed.xml...`'
74
+ FileUtils.cp(File.join(gem_root, 'combined_feed.xml'), '.')
75
+ end
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: quiet-comic
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - tjjjwxzq
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-12-01 00:00:00.000000000 Z
11
+ date: 2017-12-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -139,23 +139,14 @@ dependencies:
139
139
  description:
140
140
  email:
141
141
  - aquietimmanence@gmail.com
142
- executables: []
142
+ executables:
143
+ - quiet-comic-setup
143
144
  extensions: []
144
145
  extra_rdoc_files: []
145
146
  files:
146
147
  - LICENSE.txt
147
148
  - README.md
148
- - _artworks/demo-0.md
149
- - _artworks/demo-1.md
150
- - _artworks/demo-2.md
151
- - _artworks/demo-3.md
152
- - _artworks/demo-4.md
153
- - _artworks/demo-5.md
154
- - _artworks/demo-6.md
155
- - _artworks/demo-7.md
156
- - _artworks/demo-8.md
157
- - _artworks/demo-9.md
158
- - _artworks/demo.md
149
+ - _config.yml
159
150
  - _includes/collection_feed.xml
160
151
  - _includes/comments.html
161
152
  - _includes/facebook_javascript_sdk.html
@@ -170,17 +161,6 @@ files:
170
161
  - _layouts/home.html
171
162
  - _layouts/page.html
172
163
  - _layouts/post.html
173
- - _pages/demo-0.md
174
- - _pages/demo-1.md
175
- - _pages/demo-2.md
176
- - _pages/demo-3.md
177
- - _pages/demo-4.md
178
- - _pages/demo-5.md
179
- - _pages/demo-6.md
180
- - _pages/demo-7.md
181
- - _pages/demo-8.md
182
- - _pages/demo-9.md
183
- - _pages/demo.md
184
164
  - _sass/quiet_comic.scss
185
165
  - _sass/quiet_comic/base.scss
186
166
  - _sass/quiet_comic/components.scss
@@ -188,20 +168,43 @@ files:
188
168
  - _sass/quiet_comic/mixins.scss
189
169
  - _sass/quiet_comic/syntax_highlighting.scss
190
170
  - artworks_feed.xml
191
- - assets/fonts/GloriaHallelujah.ttf
192
- - assets/fonts/PermanentMarker.ttf
193
- - assets/images/artworks/krita.jpg
194
- - assets/images/da-icon.svg
195
- - assets/images/fb-icon.svg
196
- - assets/images/feed-icon.svg
197
- - assets/images/github-icon.svg
198
- - assets/images/instagram-icon.svg
199
- - assets/images/pages/placeholder-page.jpg
200
- - assets/images/placeholder-brand-image.png
201
- - assets/images/twitter-icon.svg
202
- - assets/images/youtube-icon.svg
203
- - assets/main.scss
171
+ - bin/quiet-comic-setup
204
172
  - pages_feed.xml
173
+ - setup_files/_artworks/demo-0.md
174
+ - setup_files/_artworks/demo-1.md
175
+ - setup_files/_artworks/demo-2.md
176
+ - setup_files/_artworks/demo-3.md
177
+ - setup_files/_artworks/demo-4.md
178
+ - setup_files/_artworks/demo-5.md
179
+ - setup_files/_artworks/demo-6.md
180
+ - setup_files/_artworks/demo-7.md
181
+ - setup_files/_artworks/demo-8.md
182
+ - setup_files/_artworks/demo-9.md
183
+ - setup_files/_artworks/demo.md
184
+ - setup_files/_pages/demo-0.md
185
+ - setup_files/_pages/demo-1.md
186
+ - setup_files/_pages/demo-2.md
187
+ - setup_files/_pages/demo-3.md
188
+ - setup_files/_pages/demo-4.md
189
+ - setup_files/_pages/demo-5.md
190
+ - setup_files/_pages/demo-6.md
191
+ - setup_files/_pages/demo-7.md
192
+ - setup_files/_pages/demo-8.md
193
+ - setup_files/_pages/demo-9.md
194
+ - setup_files/_pages/demo.md
195
+ - setup_files/assets/fonts/GloriaHallelujah.ttf
196
+ - setup_files/assets/fonts/PermanentMarker.ttf
197
+ - setup_files/assets/images/artworks/krita.jpg
198
+ - setup_files/assets/images/da-icon.svg
199
+ - setup_files/assets/images/fb-icon.svg
200
+ - setup_files/assets/images/feed-icon.svg
201
+ - setup_files/assets/images/github-icon.svg
202
+ - setup_files/assets/images/instagram-icon.svg
203
+ - setup_files/assets/images/pages/placeholder-page.jpg
204
+ - setup_files/assets/images/placeholder-brand-image.png
205
+ - setup_files/assets/images/twitter-icon.svg
206
+ - setup_files/assets/images/youtube-icon.svg
207
+ - setup_files/assets/main.scss
205
208
  homepage: https://github.com/tjjjwxzq/quiet-comic
206
209
  licenses:
207
210
  - MIT