jekyll-whiteglass 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15b5277d301cb8e5159afa6ae18ba45eadfc42a1
-  data.tar.gz: 3a9f9bf5f3eab78a8b2d716c38c450e2b4b02c89
+  metadata.gz: 951c24d99eeb70c6ff4795f28e7300d8027d40e6
+  data.tar.gz: c2cd219559e3256049ff5eecb57f538a076ca3e1
 SHA512:
-  metadata.gz: 746c9519d031b2721f38c841151b0add6875054cb3fbffc081436dd471877c11d345094d54a8d4e13ceb6885f14cb2a8266f1a4e3ff5c61ce451ad73200c036f
-  data.tar.gz: 4d921d31d28ddad1029dd2adf9eeade55fe2459745b0a273bf6f53eeaa2952cf9ff6e1b1ee2400c8f5df41a1d8709bbc0513ca539f2f37bea73c98becf044e73
+  metadata.gz: 34f85403dcfa8292f5f431274f4f79cc3ce85ff8b2573c21b8f3ba536ee6aebfe65ffe865011943b2b6e75e23735be0107c38ee6eea858c30bc26416b62d633a
+  data.tar.gz: e69ca9cc52f111c4bdfa3d60a3ddd87bdfadcb0d48f15b262462f93c5a631bb760d6651c0e57ac2206dae2b9e8d870093b5d77e57babbc28fbfbb1b795eb192f

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # ChangeLog
 
+## 1.4.0 (2017-11-01)
+
+- Support YAML list for keywords (Fix #7)
+- Add ability to provide a comments provider for pages and posts (#10)
+
 ## 1.3.0 (2017-02-20)
 
 - Fix typos of the theme description

data/README.md

@@ -34,6 +34,64 @@ Or install it yourself as:
 gem install jekyll-whiteglass
 ```
 
+## Quick Start
+
+1. Generate a new Jekyll blog:
+
+   ``` sh
+   jekyll new blog --skip-bundle
+   cd blog
+   ```
+
+2. Edit `Gemfile` to use whiteglass theme:
+
+   ``` ruby
+   gem "jekyll-whiteglass"
+   ```
+
+3. Edit `_config.yml` to use whiteglass theme and its plugins:
+
+   ``` yaml
+   theme: jekyll-whiteglass
+   gems:
+     - jekyll-archives
+     - jekyll-paginate
+     - jekyll-sitemap
+
+   permalink: /:year/:month/:day/:title/
+   paginate_path: /posts/:num/
+   paginate: 5
+
+   jekyll-archives:
+     enabled:
+       - categories
+     layout: category_archives
+     permalinks:
+       category: /categories/:name/
+   ```
+
+4. Copy
+   [`index.html`](https://github.com/yous/whiteglass/blob/master/index.html),
+   [`about.md`](https://github.com/yous/whiteglass/blob/master/about.md),
+   [`archives.md`](https://github.com/yous/whiteglass/blob/master/archives.md),
+   [`feed.xml`](https://github.com/yous/whiteglass/blob/master/feed.xml), and
+   [`_data/navigation.yml`](https://github.com/yous/whiteglass/blob/master/_data/navigation.yml)
+   from the theme:
+
+   ``` sh
+   rm index.md
+   curl -L -O "https://github.com/yous/whiteglass/raw/master/{index.html,about.md,archives.md,feed.xml}"
+   curl -L --create-dirs -o _data/navigation.yml https://github.com/yous/whiteglass/raw/master/_data/navigation.yml
+   ```
+
+5. Install gems and you're good to go! The blog will be available on
+   `http://127.0.0.1:4000`.
+
+   ``` sh
+   bundle install
+   bundle exec jekyll serve
+   ```
+
 ## Usage
 
 ### Customization
@@ -159,6 +217,16 @@ feed:
 
 Then create `<your-site>/atom.xml` with the same content of `feed.xml` above.
 
+### Comments
+
+whiteglass provides the ability to include your favourite commenting service, like [Disqus](https://disqus.com) or [Isso](https://posativ.org/isso).
+
+To enable comments on pages and posts:
+1. Overwrite the `_includes/custom_comments_provider.html` with your custom provider of comments.
+2. Add `comments: true` to your `_config.yml`.
+
+To disable comments on certain pages or posts specify `comments: false` in the front matter of the page or post.
+
 ### Metadata for SEO
 
 #### Keywords
@@ -172,6 +240,15 @@ title: How to configure jekyll-whiteglass
 keywords: jekyll, whiteglass, github pages
 ```
 
+YAML list is also available:
+
+``` yaml
+keywords:
+  - jekyll
+  - whiteglass
+  - github pages
+```
+
 #### Twitter
 
 - `site.twitter_username` sets `twitter:site` and `twitter:creator` meta tag

data/_includes/custom_comments_provider.html

@@ -0,0 +1,3 @@
+<hr />
+<h1>Comments</h1>
+<p>Insert your custom comment provider like <a href="https://disqus.com">Disqus</a> or <a href="https://posativ.org/isso">Isso</a> here.</p>

data/_includes/head.html

@@ -8,7 +8,14 @@
   {% assign description = page.description | default: page.excerpt | default: site.description | strip_html | normalize_whitespace | escape %}
   <title>{{ title }}</title>
   <meta name="description" content="{{ description }}">
-  {% if page.keywords %}<meta name="keywords" content="{{ page.keywords }}">{% endif %}
+  {% if page.keywords %}
+    {% if page.keywords.first %}
+      {% assign keywords = page.keywords | join: ',' %}
+    {% else %}
+      {% assign keywords = page.keywords %}
+    {% endif %}
+    <meta name="keywords" content="{{ keywords }}">
+  {% endif %}
 
   <link rel="stylesheet" href="{{ "/assets/main.css" | relative_url }}">
   <link rel="canonical" href="{{ canonical }}">

data/_layouts/page.html

@@ -11,4 +11,10 @@ layout: default
     {{ content }}
   </div>
 
+  {% if site.comments != false and page.comments != false %}
+    <div class="post-comments">
+      {% include custom_comments_provider.html %}
+    </div>
+  {% endif %}
+
 </article>

data/_layouts/post.html

@@ -16,4 +16,10 @@ layout: default
     {{ content }}
   </div>
 
+  {% if site.comments != false and page.comments != false %}
+    <div class="post-comments" itemprop="comment">
+      {% include custom_comments_provider.html %}
+    </div>
+  {% endif %}
+
 </article>

data/_sass/whiteglass.scss

@@ -1,5 +1,5 @@
 // Define defaults for each variable.
-$base-font-family: Bitter, "Apple SD Gothic Neo", AppleGothic, NanumBarunGothic, "Malgun Gothic", Dotum, sans-serif !default;
+$base-font-family: Bitter, "Apple SD Gothic Neo", "Noto Sans", "Source Han Sans", "Noto Sans CJK JP", "Source Han Sans JP", "Noto Sans CJK KR", "Source Han Sans KR", NanumBarunGothic, AppleGothic, "Malgun Gothic", Dotum, sans-serif !default;
 $monospace-font-family: Monaco, Menlo, Consolas, "Courier New", DotumChe, monospace !default;
 $base-font-size:   16px !default;
 $base-font-weight: 400 !default;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-whiteglass
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Chayoung You
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-20 00:00:00.000000000 Z
+date: 2017-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -105,6 +105,7 @@ files:
 - LICENSE.txt
 - README.md
 - _includes/category_links.html
+- _includes/custom_comments_provider.html
 - _includes/fonts.html
 - _includes/footer.html
 - _includes/footer_content.html
@@ -145,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Minimal, responsive Jekyll theme for hackers.