quiet-comic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eabe6236b5c7862fc79efe56bd0f4700c99a0760
+  data.tar.gz: c1ccf6c90b2f96f948122537117eebde1f1d947c
+SHA512:
+  metadata.gz: 1176c6d72c5e08b961d47c3ee42f9993803f57281cede3660c41895f7e4487f0cebade5aaca47792ebb97a72a3ac8992e244b0b85a6b9fc9de4a37e469346661
+  data.tar.gz: b23490c3a7e6056c2157fa13ab88464caeefc2d4f1f9aecaf59962379057aeb3e27301b1ccc2f788dae6904f30ee69a500f02b4f968059b1d1f0903dd8d2931e

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 tjjjwxzq
+
+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:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,198 @@
+# Quiet Comic
+
+A simple webcomic theme with pagination support for your comic pages and any related art.
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "quiet-comic"
+```
+
+Then copy the [theme's default `_config.yml`](https://github.com/tjjjwxzq/quiet-comic/blob/master/_config.yml) into your Jekyll site's `_config.yml`, and then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quiet-comic
+
+## Usage
+
+### Getting Started
+
+#### Base Config
+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`.
+
+#### Collection folders
+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
+
+```bash
+bundle show quiet-comic
+```
+
+in your project directory.
+
+If you run your website now you should be able to visit all the basic pages without any 404 errors.
+
+#### Image Thumbnails
+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.
+
+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).
+
+#### Feed templates
+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.
+
+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>`.
+
+### Configuration
+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.
+
+### Layouts
+
+The layouts are:
+
+- `default.html` - base layout for all layouts. Sets the doctype, `<head>` element, and a header include.
+- `home.html` - landing page with a full screen div for your beautiful cover art
+- `page.html` - a single comic page
+- `artwork.html` - a single artwork page
+- `autopage_collection.html` - this is used by the AutoPages feature of the `jekyll-paginate-v2` gem to generate a paginated index for comic pages as well as artworks (or any collections you care to add to your website)
+- `post.html` - a very minimal layout for blog posts. If you really want proper blog posts on your website, make sure to override and style this layout properly (blog posts are not the focus of this theme, however - jekyll just provides this functionality by default)
+
+To override these layouts, create a `_layouts` directory and a new file with the name corresponding to the layout you want to override (eg. `_layouts/home.html`).
+
+### Includes
+- `head.html` - defines the `<head></head>` tag used in the `default` layout
+- `seo.html` - bunch of tags for SEO included in `head.html`
+- `header.html` - defines the site's main header with a responsive navbar
+- `footer.html` - site's footer with author bio and social media links (links will show up only if you specify a link to your social media sites in `_config.yml`)
+- `google-analytics` - code analytics inserted in the `default` layout (only active in production)
+- `comments` - code for facebook comment box
+- `facebook_javascript_sdk.html` - code for including the Facebook Javascript SDK in the `default` layout
+- `collection_feed.xml` - used to generate an Atom feed for each of your collections. You need to create a `<collection>_feed.xml` in your root folder for the feed file to be generated
+
+### Sass
+To override the Sass in this theme, create a `_sass` directory and add your desired sass files. Then, create a `assets/main.scss` file and import your files as well as the theme's stylesheet:
+
+```scss
+@import 'myfile';
+\\ ... import your sass files above to override theme defaults
+@import 'quiet-comic';
+```
+
+### Collections
+
+#### Pages
+You should at minimum include the following font matter in your page:
+
+```
+---
+page_number: 1
+image: 'path/to/comic/strip/image'
+---
+```
+
+Your pages will be sorted on the `page_number` variable so it must be included.
+
+The `page_number` will be displayed on the page itself, and, depending on your config, in the pages index on the thumbnail for that page (see how to generate your thumbnail images [here](#thumbnails)).
+
+The `image` should be the path to the comic strip file itself, relative to the base image directory. The base image directory for comic pages is `<base_image_dir>/pages`. Since the default base image directory is `assets/images`, this will be `assets/images/pages`. If you would like to change the base directory name, you can set the following in your config:
+
+```yaml
+base_image_dir: '/new/path/to/images/directory'
+```
+
+You can optionally include a `title`, `date` key (it's recommended), and this will be displayed on the page alongside the `page_number`.
+
+You can specify whether you want the thumbnail label to show the `page_number` or the `title` by setting the following key in your `_config.yml` (`page_number` is the default):
+
+```yaml
+thumbnail_label: "page_number" # or "title"
+```
+
+Likewise, you can specify whether the feed `<title></title>` tag in each feed `<entry>` should show the `page_number` or the `title` by setting the following in your `_config.yml` (`page_number` is the default):
+
+```yaml
+feed_label: "page_number" # or title
+```
+
+Note that if you don't have a `title` key specified in your frontmatter, the `page.title` variable defaults to the name of your file (which may or may not be what you expect).
+
+##### Chapters
+
+#### Artworks
+Your frontmatter should at minimum include:
+
+```
+---
+title: Some title
+date: YYYY-MM-DD
+image: "path/to/image/file"
+---
+```
+
+The date is required to sort your artworks in chronological order (when displayed in the gallery page as well as in the feed). Note that it must be written in the `YYYY-MM-DD` ISO 8601 format for it to be recognized as a `Date` by Jekyll (or it will end up a string and sorting won't work as expected).
+
+The `image` should be the path to the artwork file itself, relative to the base image directory. The base image directory for artworks is `<base_image_dir>/artworks`. Since the default base image directory is `assets/images`, this will be `assets/images/pages`. If you would like to change the directory name, you can set the following in your config:
+
+```yaml
+base_image_dir: '/new/path/to/images/directory'
+```
+
+### <a name="thumbnails">Thumbnails</a>
+
+This theme uses the `jekyll-minimagick` gem to automatically generate thumbnails for your comics or artworks based on your supplied configuration. By default you should put your comic page images into `assets/images/pages` and your artwork images into `assets/images/artworks`, and the thumbnails will be generated in the `assets/images/pages/thumbnails` and `assets/images/artworks/thumbnails` directories respectively. If you would like to change the default config, you can edit the `mini_magick` key in `_config.yml`:
+
+```yaml
+# jekyll-minimagick config
+mini_magick:
+  pages_thumbnails:
+    source: "assets/images/pages"
+    destination: "assets/images/pages/thumbnails"
+    crop: "300x300+0+0"
+  artworks_thumbnails:
+    source: "assets/images/artworks"
+    destination: "assets/images/artworks/thumbnails"
+    crop: "300x300+0+0"
+```
+
+(For the `crop` option, the value must be of the form `width x height + x-offset + y-offset`. The offsets are mandatory, or minimagick will throw an error)
+
+Note that if you change the source directories, you should also make the relevant changes to the `base_image_dir`.
+
+### Feed
+This theme uses the `jekyll-feed` gem to generate an Atom feed for your posts (`feed.xml`) (if you are running a blog alongside your web comic). However this gem does not support feed for collections.
+
+This theme will create a feed for your comic pages (`pages_feed.xml`), artwork (`artwork_feed.xml`) and a combined feed for both (`combined_feed.xml`). The feed will sort your comic pages according to `page_number`, and your artworks according to `date` (so ensure that those variables are set in your frontmatter).
+
+### Syntax Highlighting
+This theme uses [rouge](https://github.com/jneen/rouge) for syntax highlighting (which is Jekyll's default highlighter). The syntax highlighting stylsheet uses the Zenburn theme. To override the theme, create a `_sass/syntax_highlighting.scss` file, put in your desired styles, and import it before the `quiet_comic` stylesheet in `assets/main.scss`. You can find other syntax highlighting styles here: [http://jwarby.github.io/jekyll-pygments-themes/languages/javascript.html](http://jwarby.github.io/jekyll-pygments-themes/languages/javascript.html).
+
+### SEO
+A set of meta tags for SEO are included in `<head></head>`. To see what's included, check out the source file `_includes/seo.html` (Do `bundle open quiet-comic` to open the gem source). Config that affects the output of these SEO tags can be found in `_config.yml`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Development
+
+To set up your environment to develop this theme, run `bundle install`.
+
+Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
+
+When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
+To add a custom directory to your theme-gem, please edit the regexp in `quiet-comic.gemspec` accordingly.
+
+### TODO
+1. Figure out image thumbnails in feed
+3. Test-run the theme and check which should be spec files
+5. Home page illustration and six simple comic pages
+6. One simple artwork
+7. Support grouping pages into chapters
+8. Write a setup script
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_artworks/demo-0.md

@@ -0,0 +1,7 @@
+---
+title: BOOY
+date: 2017-10-30
+image: "krita.jpg"
+---
+
+Krita looking kickass!

data/_artworks/demo-1.md

@@ -0,0 +1,7 @@
+---
+title: Krita
+date: 2017-08-18
+image: "krita.jpg"
+---
+
+Krita looking kickass!

data/_artworks/demo-2.md

@@ -0,0 +1,7 @@
+---
+title: Krita
+date: 2017-08-18
+image: "krita.jpg"
+---
+
+Krita looking kickass!

data/_artworks/demo-3.md

@@ -0,0 +1,7 @@
+---
+title: Krita
+date: 2017-08-18
+image: "krita.jpg"
+---
+
+Krita looking kickass!

data/_artworks/demo-4.md

@@ -0,0 +1,7 @@
+---
+title: Krita
+date: 2017-08-18
+image: "krita.jpg"
+---
+
+Krita looking kickass!

data/_artworks/demo-5.md

@@ -0,0 +1,7 @@
+---
+title: Krita
+date: 2017-08-18
+image: "krita.jpg"
+---
+
+Krita looking kickass!

data/_artworks/demo-6.md

@@ -0,0 +1,7 @@
+---
+title: Krita
+date: 2017-08-18
+image: "krita.jpg"
+---
+
+Krita looking kickass!

data/_artworks/demo-7.md

@@ -0,0 +1,7 @@
+---
+title: Krita
+date: 2017-08-18
+image: "krita.jpg"
+---
+
+Krita looking kickass!

data/_artworks/demo-8.md

@@ -0,0 +1,7 @@
+---
+title: Krita
+date: 2017-08-18
+image: "krita.jpg"
+---
+
+Krita looking kickass!

data/_artworks/demo-9.md

@@ -0,0 +1,7 @@
+---
+title: Krita
+date: 2017-08-18
+image: "krita.jpg"
+---
+
+Krita looking kickass!

data/_artworks/demo.md

@@ -0,0 +1,7 @@
+---
+title: Krita
+date: 2017-08-18
+image: "krita.jpg"
+---
+
+Krita looking kickass!

data/_includes/collection_feed.xml

@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="utf-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+  <generator uri="https://jekyllrb.com/" version="{{ jekyll.version }}">Jekyll</generator>
+  <link href="{{ page.url | absolute_url }}" rel="self" type="application/atom+xml" />
+  <link href="{{ '/' | absolute_url }}" rel="alternate" type="text/html" />
+  <updated>{{ site.time | date_to_xmlschema }}</updated>
+  <id>{{ '/' | absolute_url | xml_escape }}</id>
+
+  {% if site.title %}
+  <title type="html">{{ site.title | smartify | xml_escape }}</title>
+  {% elsif site.name %}
+  <title type="html">{{ site.name | smartify | xml_escape }}</title>
+  {% endif %}
+
+  {% if site.description %}
+  <subtitle>{{ site.description | xml_escape }}</subtitle>
+  {% endif %}
+
+  {% if site.author %}
+  <author>
+    <name>{{ site.author.name | default: site.author | xml_escape }}</name>
+    {% if site.author.email %}
+    <email>{{ site.author.email | xml_escape }}</email>
+    {% endif %}
+    {% if site.author.uri %}
+    <uri>{{ site.author.uri | xml_escape }}</uri>
+    {% endif %}
+  </author>
+  {% endif %}
+
+  {% assign collection_name = page.collection %}
+  {% case collection_name %}
+  {% when "pages" %}
+  {% assign items = (site[collection_name] | sort: 'page_number' | reverse) %}
+  {% when "artworks" %}
+  {% assign items = (site[collection_name] | sort: 'date' | reverse) %}
+  {% else %}
+  {% assign pages = (site["pages"] | sort: 'page_number') %}
+  {% assign artworks = (site["artworks"] | sort: 'date') %}
+  {% assign items = (pages | concat: artworks | sort: 'date' | reverse) %}
+  {% endcase %}
+
+  {% for item in items limit: 10 %}
+  <entry>
+    <title>
+      {% case site.feed_label %}
+      {% when 'page_number' %}
+      {{ item.page_number | default: item.title }}
+      {% else %}
+      {{ item.title }}
+      {% endcase %}
+    </title>
+    <link href="{{ item.url | absolute_url }}" rel="alternate" type="text/html" title="{{ item.title | xml_escape }}" />
+    {% if item.date %}
+    <published>{{ item.date | date_to_xmlschema }}</published>
+    {% endif %}
+    <updated>{{ item.last_modified_at | default: item.date | date_to_xmlschema }}</updated>
+    <id>{{ item.id | absolute_url | xml_escape }}</id>
+    <content type="html" xml:base="{{ post.url | absolute_url | xml_escape }}">
+      {{ item.content | strip | xml_escape }}
+    </content>
+
+    <author>
+      <name>{{ site.author.name | default: "" }}</name>
+      {% if site.author.email %}
+      <email>{{ site.author.email }}</email>
+      {% endif %}
+      {% if site.author.uri %}
+      <uri>{{ site.author.uri }}</uri>
+      {% endif %}
+    </author>
+
+    {% unless item.image contains "://" %}
+    {% assign item_image = item.image | absolute_url | xml_escape %}
+    {% endunless %}
+    <media:thumbnail xmlns:media="http://search.yahoo.com/mrss/" url="{{ item_image }}" />
+
+  </entry>
+  {% endfor %}
+</feed>

data/_includes/comments.html

@@ -0,0 +1,11 @@
+<div class="comments-container">
+  <h4>Comments</h4>
+  <section
+    class="fb-comments"
+    data-href="{{ page.url | absolute_url }}"
+    data-mobile="true"
+    data-numposts="{{ site.comments.facebook.num_posts | default: 5 }}"
+    data-width="100%"
+    data-colorscheme="{{ site.comments.facebook.colorscheme | default: 'light' }}"
+    ></section>
+</div>

data/_includes/facebook_javascript_sdk.html

@@ -0,0 +1,8 @@
+<div id="fb-root"></div>
+<script>(function(d, s, id) {
+  var js, fjs = d.getElementsByTagName(s)[0];
+  if (d.getElementById(id)) return;
+  js = d.createElement(s); js.id = id;
+  js.src = 'https://connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.11';
+  fjs.parentNode.insertBefore(js, fjs);
+}(document, 'script', 'facebook-jssdk'));</script>

data/_includes/footer.html

@@ -0,0 +1,50 @@
+<footer>
+  <div class="bio-container">
+    <h5>{{ site.title }}</h5>
+    <p><strong>{{ site.author.name }}</strong> &middot; {{ site.author.bio }}</p>
+  </div>
+  <ul class="social-links">
+    {% if site.author.github %}
+      <li>
+        <a href="{{ site.author.github }}">
+          <img src="{{ site.base_image_dir | append: 'github-icon.svg' | relative_url }}" />
+        </a>
+      </li>
+    {% endif %}
+    {% if site.author.deviant_art %}
+      <li>
+        <a href="{{ site.author.deviant_art }}">
+          <img src="{{ site.base_image_dir | append: 'da-icon.svg' | relative_url}}" />
+        </a>
+      </li>
+    {% endif %}
+    {% if site.author.facebook %}
+      <li>
+        <a href="{{ site.author.facebook }}">
+          <img src="{{ site.base_image_dir | append: 'fb-icon.svg' | relative_url }}" />
+        </a>
+      </li>
+    {% endif %}
+    {% if site.author.instagram %}
+      <li>
+        <a href="{{ site.author.instagram }}">
+          <img src="{{ site.base_image_dir | append: 'instagram-icon.svg' | relative_url }}" />
+        </a>
+      </li>
+    {% endif %}
+    {% if site.author.twitter %}
+      <li>
+        <a href="{{ site.author.twitter }}">
+          <img src="{{ site.base_image_dir | append: 'twitter-icon.svg' | relative_url }}" />
+        </a>
+      </li>
+    {% endif %}
+    {% if site.author.youtube %}
+      <li>
+        <a href="{{ site.author.youtube }}">
+          <img src="{{ site.base_image_dir | append: 'youtube-icon.svg' | relative_url }}" />
+        </a>
+      </li>
+    {% endif %}
+  </ul>
+</footer>