jekyll-theme-basically-basic 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55ed4d4512c7304e57fb6fd110060bbc3f88dd4f
-  data.tar.gz: '090a93bbfe4dccdee9beb54d1440c8b9cf85cb31'
+  metadata.gz: 6edd102295a93f0c2bd7e295faf1f2270b5030ed
+  data.tar.gz: b82490970368af4513ed5c7d31476dd11c55d197
 SHA512:
-  metadata.gz: 2f64772f662b9b0fd3fc21273704f93760068ad3f67cd753d18aff71873d13a494f6a0af4015ab3110457ebc715c18d0f69061d3c924ac43e332158d8963c2c5
-  data.tar.gz: 895897592ad85773576288ed7820cd176e24f7f04281ea1b1eefa55d201d853b4bcadb55956496d8b3279441f7f7932322f4c2036e036b45f56a4fc244485340
+  metadata.gz: 02bd149e74998b1dc70f5ffec38b43f03d63a9e9ab42835dba8d3fb2252338069a84c483b5a90aba7844b2ee7bf8a93ece3b24ac92a58a39394b06b5a318d563
+  data.tar.gz: dc3926be96aabd70ba2bb9caa69c64dee9bbf3c856651acc47e1ce94aa6773dd68d7f6f53a09e0fc263558469fdf906d3cf78dbdf7ce4d2a23753f4395f047f4

data/CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.4.0] - 2018-04-02
+
+## Changed
+- Lint JavaScript.
+- Update gemspec to use jekyll-seo-tag version `2.4`. [#47](https://github.com/mmistakes/jekyll-theme-basically-basic/pull/47)
+
+### Added
+- Accessibility enhancements for Lunr search form.
+- Add SCSS `$intro-image-color-overlay` variable to enable color overlay on hero images (disabled by default). [#55](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/55)
+- Add new archive layouts: `posts`, `categories`, `category`, `collection`, `tag`, and `tags`.
+- Add grid layout via `entries_layout: grid` front matter.
+- Add support for image thumbnails vial `image.thumbnail` front matter.
+
+### Fixed
+- Fix Firefox [flexbox bug](https://bugzilla.mozilla.org/show_bug.cgi?id=939897) when printing pages.
+- Fix search excerpts that run together because of implied spaces.
+- Moved `<footer>` outside of `<main>` to be semantically correct.
+
 ## [1.3.1] - 2018-02-16
 
 ### Changed

data/README.md

@@ -6,9 +6,8 @@
 [![Tip Me via PayPal](https://img.shields.io/badge/PayPal-tip%20me-green.svg?logo=paypal)](https://www.paypal.me/mmistakes)
 
 Basically Basic is a [Jekyll theme](https://jekyllrb.com/docs/themes/) meant as 
-a substitute for the default --- [Minima](https://github.com/jekyll/minima). 
-Conventions and features found there are fully supported by **Basically Basic**, 
-with a few enhancements thrown in for good measure:
+a substitute for the default [Minima](https://github.com/jekyll/minima), with a 
+few enhancements thrown in for good measure:
 
 - Clean responsive design with [six customizable skins](#skin)
 - Curriculum Vitæ/Resume layout powered by [JSON data](http://registry.jsonresume.org/)
@@ -25,49 +24,55 @@ with a few enhancements thrown in for good measure:
 ## Table of Contents
 
 1. [Installation](#installation)
-    1. [Ruby Gem Method](#ruby-gem-method)
-    2. [GitHub Pages Method](#github-pages-method)
-        1. [Remove the Unnecessary](#remove-the-unnecessary)
+   1. [Ruby Gem Method](#ruby-gem-method)
+   2. [GitHub Pages Method](#github-pages-method)
+      1. [Remove the Unnecessary](#remove-the-unnecessary)
 2. [Upgrading](#upgrading)
-    1. [Ruby Gem](#ruby-gem)
-    2. [Remote Theme](#remote-theme)
-    3. [Use Git](#use-git)
-        1. [Pull Down Updates](#pull-down-updates)
-    4. [Update Files Manually](#update-files-manually)
+   1. [Ruby Gem](#ruby-gem)
+   2. [Remote Theme](#remote-theme)
+   3. [Use Git](#use-git)
+      1. [Pull Down Updates](#pull-down-updates)
+   4. [Update Files Manually](#update-files-manually)
 3. [Structure](#structure)
-    1. [Starting Fresh](#starting-fresh)
-    2. [Starting from `jekyll new`](#starting-from-jekyll-new)
+   1. [Starting Fresh](#starting-fresh)
+   2. [Starting from `jekyll new`](#starting-from-jekyll-new)
 4. [Configuration](#configuration)
-    1. [Skin](#skin)
-    2. [Google Fonts](#google-fonts)
-    3. [Text](#text)
-    4. [Navigation](#navigation)
-    5. [Pagination](#pagination)
-    6. [Search](#search)
-        1. [Lunr (default)](#lunr-default)
-        2. [Algolia](#algolia)
-    7. [Author](#author)
-    8. [Reading Time](#reading-time)
-    9. [Comments (via Disqus)](#comments-via-disqus)
-    10. [Google Analytics](#google-analytics)
+   1. [Skin](#skin)
+   2. [Google Fonts](#google-fonts)
+   3. [Text](#text)
+   4. [Navigation](#navigation)
+   5. [Pagination](#pagination)
+   6. [Search](#search)
+      1. [Lunr (default)](#lunr-default)
+      2. [Algolia](#algolia)
+   7. [Author](#author)
+   8. [Reading Time](#reading-time)
+   9. [Comments (via Disqus)](#comments-via-disqus)
+   10. [Google Analytics](#google-analytics)
 5. [Layouts](#layouts)
-    1. [`layout: default`](#layout-default)
-    2. [`layout: post`](#layout-post)
-    3. [`layout: page`](#layout-page)
-    4. [`layout: home`](#layout-home)
-    5. [`layout: about`](#layout-about)
-    6. [`layout: cv`](#layout-cv)
-6. [Customization](#customization)
-    1. [Overriding Includes and Layouts](#overriding-includes-and-layouts)
-    2. [Customizing Sass (SCSS)](#customizing-sass-scss)
-    3. [Customizing JavaScript](#customizing-javascript)
-    4. [SVG Icons](#svg-icons)
-    5. [Customizing Sidebar Content](#customizing-sidebar-content)
-7. [Development](#development)
-8. [Contributing](#contributing)
-    1. [Pull Requests](#pull-requests)
-9. [Credits](#credits)
-10. [License](#license)
+   1. [`layout: default`](#layout-default)
+   2. [`layout: post`](#layout-post)
+   3. [`layout: page`](#layout-page)
+   4. [`layout: home`](#layout-home)
+   5. [`layout: posts`](#layout-posts)
+   6. [`layout: categories`](#layout-categories)
+   7. [`layout: tags`](#layout-tags)
+   8. [`layout: collection`](#layout-collection)
+   9. [`layout: category`](#layout-category)
+   10. [`layout: tag`](#layout-tag)
+   11. [`layout: about`](#layout-about)
+   12. [`layout: cv`](#layout-cv)
+6. [Images](#images)
+7. [Customization](#customization)
+   1. [Overriding Includes and Layouts](#overriding-includes-and-layouts)
+   2. [Customizing Sass (SCSS)](#customizing-sass-scss)
+   3. [Customizing JavaScript](#customizing-javascript)
+   4. [SVG Icons](#svg-icons)
+   5. [Customizing Sidebar Content](#customizing-sidebar-content)
+8. [Development](#development)
+9. [Contributing](#contributing)
+10. [Credits](#credits)
+11. [License](#license)
 
 ## Installation
 
@@ -464,6 +469,8 @@ For faster and more relevant search ([see demo](https://mmistakes.github.io/jeky
 
 To use the Algolia search with GitHub Pages hosted sites follow [this deployment guide](https://community.algolia.com/jekyll-algolia/github-pages.html). Or this guide for [deploying on Netlify](https://community.algolia.com/jekyll-algolia/netlify.html).
 
+**Note:** The Jekyll Algolia plugin can be configured in several ways. Be sure to check out [their full documentation](https://community.algolia.com/jekyll-algolia/options.html "Algolia configuration") on how to exclude files and other valuable settings.
+
 ### Author
 
 Author information is used as meta data for post "by lines" and propagates the 
@@ -601,6 +608,12 @@ author:
 comments: false  # disable comments on this post
 ```
 
+**Note:** Hero images can be overlaid with a transparent "accent" color to unify them with the theme's palette. To enable, [customize the CSS](#customizing-sass-scss) with the following Sass variable override:
+
+```scss
+$intro-image-color-overlay: true;
+```
+
 ### `layout: page`
 
 Visually this layout looks and acts the same as `layout: post`, with two minor 
@@ -616,6 +629,90 @@ addition of the following:
 
 ```yaml
 paginate: true  # enables pagination loop, see section above for additional setup
+entries_layout: # list (default), grid
+```
+
+By default, posts are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter.
+
+### `layout: posts`
+
+This layout displays all posts grouped by the year they were published. It accommodates the same front matter as `layout: page`.
+
+By default, posts are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter.
+
+### `layout: categories`
+
+This layout displays all posts grouped category. It accommodates the same front matter as `layout: page`.
+
+By default, posts are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter.
+
+### `layout: tags`
+
+This layout displays all posts grouped by tag. It accommodates the same front matter as `layout: page`.
+
+By default, posts are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter.
+
+### `layout: collection`
+
+This layout displays all documents grouped by a specific collection. It accommodates the same front matter as `layout: page` with the addition of the following:
+
+```yaml
+collection: # collection name
+entries_layout: # list (default), grid
+show_excerpts: # true (default), false
+sort_by: # date (default) title
+sort_order: # forward (default), reverse
+```
+
+To create a page showing all documents in the `recipes` collection you'd create `recipes.md` in the root of your project and add this front matter:
+
+```yaml
+title: Recipes
+layout: collection
+permalink: /recipes/
+collection: recipes
+```
+
+By default, documents are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter. If you want to sort the collection by title add `sort_by: title`. If you want reverse sorting, add `sort_order: reverse`.
+
+### `layout: category`
+
+This layout displays all posts grouped by a specific category. It accommodates the same front matter as `layout: page` with the addition of the following:
+
+```yaml
+taxonomy: # category name
+entries_layout: # list (default), grid
+```
+
+By default, posts are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter.
+
+To create a page showing all posts assigned to the category `foo` you'd create `foo.md` in the root of your project and add this front matter:
+
+```yaml
+title: Foo
+layout: category
+permalink: /categories/foo/
+taxonomy: foo
+```
+
+### `layout: tag`
+
+This layout displays all posts grouped by a specific tag. It accommodates the same front matter as `layout: page` with the addition of the following:
+
+```yaml
+taxonomy: # tag name
+entries_layout: # list (default), grid
+```
+
+By default, posts are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter.
+
+To create a page showing all posts assigned to the tag `foo bar` you'd create `foo-bar.md` in the root of your project and add this front matter:
+
+```yaml
+title: Foo Bar
+layout: tag
+permalink: /tags/foo-bar/
+taxonomy: foo bar
 ```
 
 ### `layout: about`
@@ -644,6 +741,17 @@ resume data to conveniently render a curriculum vitæ or resume painlessly.
 Simply use JSON Resume's [in-browser resume builder](http://registry.jsonresume.org/) 
 to export a JSON file and save to your project as `_data/cv.json`.
 
+## Images
+
+Suggested image sizes in pixels are as follows:
+
+| Image | Description | Size |
+| ----- | ----------- | ---- |
+| `page.image.path` | Large full-width document image. | Tall images will push content down the page. `1600 x 600` is a good middle-ground size to aim for. |
+| `page.image` | Short-hand for `page.image.path` when used alone (without `thumbnail`, `caption`, or other variables). | Same as `page.image.path` |
+| `page.image.thumbnail` | Small document image used in grid view. | `400 x 200` |
+| `author.picture` | Author page image. | `300 x 300` |
+
 ## Customization
 
 The default structure, style, and scripts of this theme can be overridden and 

data/_includes/author

@@ -1,31 +1,31 @@
-{% assign author = page.author | default: page.authors[0] | default: site.author %}
-{% if author %}
-  {% if author.name %}
-    {% assign author_name = author.name %}
-  {% else %}
-    {% if site.data.authors and site.data.authors[author] %}
-      {% assign author_name = site.data.authors[author].name %}
-    {% else %}
-      {% assign author_name = author %}
-    {% endif %}
-  {% endif %}
-
-  {% if author.picture %}
-    {% assign author_picture = author.picture %}
-  {% else %}
-    {% if site.data.authors and site.data.authors[author] %}
-      {% assign author_picture = site.data.authors[author].picture %}
-    {% endif %}
-    {% unless author_picture contains '://' %}{% assign author_picture = author_picture | relative_url %}{% endunless %}
-  {% endif %}
-
-  {% if author.twitter %}
-    {% assign author_twitter = author.twitter %}
-  {% else %}
-    {% if site.data.authors and site.data.authors[author] %}
-      {% assign author_twitter = site.data.authors[author].twitter %}
-    {% else %}
-      {% assign author_twitter = site.twitter_username %}
-    {% endif %}
-  {% endif %}
+{% assign author = page.author | default: page.authors[0] | default: site.author %}
+{% if author %}
+  {% if author.name %}
+    {% assign author_name = author.name %}
+  {% else %}
+    {% if site.data.authors and site.data.authors[author] %}
+      {% assign author_name = site.data.authors[author].name %}
+    {% else %}
+      {% assign author_name = author %}
+    {% endif %}
+  {% endif %}
+
+  {% if author.picture %}
+    {% assign author_picture = author.picture %}
+  {% else %}
+    {% if site.data.authors and site.data.authors[author] %}
+      {% assign author_picture = site.data.authors[author].picture %}
+    {% endif %}
+    {% unless author_picture contains '://' %}{% assign author_picture = author_picture | relative_url %}{% endunless %}
+  {% endif %}
+
+  {% if author.twitter %}
+    {% assign author_twitter = author.twitter %}
+  {% else %}
+    {% if site.data.authors and site.data.authors[author] %}
+      {% assign author_twitter = site.data.authors[author].twitter %}
+    {% else %}
+      {% assign author_twitter = site.twitter_username %}
+    {% endif %}
+  {% endif %}
 {% endif %}

data/_includes/contact-list.html

@@ -1,27 +1,27 @@
-<ul class="contact-list">
-  {% if site.email %}
-    <li>
-      <a href="mailto:{{ site.email }}">
-        <span class="icon icon--email">{% include icon-email.svg %}</span>
-        <span class="label">{{ site.data.theme.t.email | default: 'Email' }}</span>
-      </a>
-    </li>
-  {% endif %}
-
-  {% if site.github_username %}
-    <li>{% include icon-github.html username=site.github_username label='GitHub' %}</li>
-  {% endif %}
-
-  {% if site.twitter_username %}
-    <li>{% include icon-twitter.html username=site.twitter_username label='Twitter' %}</li>
-  {% endif %}
-
-  <li>
-    {% if site.plugins contains 'jekyll-feed' or site.gems contains 'jekyll-feed' %}
-      <a href="{{ site.feed.path | default: 'feed.xml' | relative_url }}" title="Atom Feed">
-        <span class="icon icon--rss">{% include icon-rss.svg %}</span>
-        <span class="label">{{ site.data.theme.t.subscribe | default: 'Subscribe' }}</span>
-      </a>
-    {% endif %}
-  </li>
-</ul>
+<ul class="contact-list">
+  {% if site.email %}
+    <li>
+      <a href="mailto:{{ site.email }}">
+        <span class="icon icon--email">{% include icon-email.svg %}</span>
+        <span class="label">{{ site.data.theme.t.email | default: 'Email' }}</span>
+      </a>
+    </li>
+  {% endif %}
+
+  {% if site.github_username %}
+    <li>{% include icon-github.html username=site.github_username label='GitHub' %}</li>
+  {% endif %}
+
+  {% if site.twitter_username %}
+    <li>{% include icon-twitter.html username=site.twitter_username label='Twitter' %}</li>
+  {% endif %}
+
+  <li>
+    {% if site.plugins contains 'jekyll-feed' or site.gems contains 'jekyll-feed' %}
+      <a href="{{ site.feed.path | default: 'feed.xml' | relative_url }}" title="Atom Feed">
+        <span class="icon icon--rss">{% include icon-rss.svg %}</span>
+        <span class="label">{{ site.data.theme.t.subscribe | default: 'Subscribe' }}</span>
+      </a>
+    {% endif %}
+  </li>
+</ul>

data/_includes/cv/awards.html

@@ -1,24 +1,24 @@
-{% if cv.awards %}
-  <div id="awards" class="entry">
-    <header class="entry-header">
-      <h3 class="entry-title">Awards</h3>
-    </header>
-
-    <div class="entry-content">
-      {% for a in cv.awards %}
-        {% if a.title %}
-          <h4 class="title">{{ a.title }}</h4>
-        {% endif %}
-        {% if a.date %}
-          <div class="date">{{ a.date }}</div>
-        {% endif %}
-        {% if a.awarder %}
-          <h5 class="awarder">{{ a.awarder }}</h5>
-        {% endif %}
-        {% if a.summary %}
-          <div class="summary">{{ a.summary | markdownify }}</div>
-        {% endif %}
-      {% endfor %}
-    </div>
-  </div>
+{% if cv.awards %}
+  <div id="awards" class="entry">
+    <header class="entry-header">
+      <h3 class="entry-title">Awards</h3>
+    </header>
+
+    <div class="entry-content">
+      {% for a in cv.awards %}
+        {% if a.title %}
+          <h4 class="title">{{ a.title }}</h4>
+        {% endif %}
+        {% if a.date %}
+          <div class="date">{{ a.date }}</div>
+        {% endif %}
+        {% if a.awarder %}
+          <h5 class="awarder">{{ a.awarder }}</h5>
+        {% endif %}
+        {% if a.summary %}
+          <div class="summary">{{ a.summary | markdownify }}</div>
+        {% endif %}
+      {% endfor %}
+    </div>
+  </div>
 {% endif %}

data/_includes/cv/basics.html

@@ -1,69 +1,69 @@
-{% if cv.basics.summary %}
-  <div class="summary">
-    {{ cv.basics.summary | markdownify }}
-  </div>
-{% endif %}
-
-<div id="contact" class="entry">
-  <header class="entry-header">
-    <h3 class="entry-title">Contact</h3>
-  </header>
-
-  <div class="entry-content">
-    {% if cv.basics.email %}
-      <div class="email"><strong>Email</strong> <a href="mailto:{{ cv.basics.email }}">{{ cv.basics.email }}</a></div>
-    {% endif %}
-    {% if cv.basics.phone %}
-      <div class="phone"><strong>Phone</strong> {{ cv.basics.phone }}</div>
-    {% endif %}
-    {% if cv.basics.website %}
-      <div class="website"><strong>Website</strong> <a href="{{ cv.basics.website }}">{{ cv.basics.website }}</a></div>
-    {% endif %}
-    {% if cv.basics.profiles %}
-      {% for p in cv.basics.profiles %}
-        <div class="item">
-          {% if p.network %}
-            <strong class="network">{{ p.network | append: ' ' }}</strong>
-          {% endif %}
-          {% if p.username %}
-            <span class="username">
-              {% unless p.url == '' or p.url == nil %}
-                <a href="{{ p.url }}">{{ p.username }}</a>
-              {% else %}
-                {{ p.username }}
-              {% endunless %}
-            </span>
-          {% endif %}
-        </div>
-      {% endfor %}
-    {% endif %}
-  </div>
-</div>
-
-{% if cv.basics.location %}
-  <div id="location" class="entry">
-    <header class="entry-header">
-      <h3 class="entry-title">Location</h3>
-    </header>
-
-    <div class="entry-content">
-      <address>
-        {% if cv.basics.location.address %}
-          <span class="address">{{ cv.basics.location.address }}</span><br />
-        {% endif %}
-        {% if cv.basics.location.city %}
-          <span class="city">{{ cv.basics.location.city | append: ', ' }}</span>
-        {% endif %}
-        {% if cv.basics.location.region %}
-          <span class="region">{{ cv.basics.location.region | append: ' ' }}</span>
-        {% endif %}
-        {% if cv.basics.location.postalCode %}
-          <span class="postalCode">{{ cv.basics.location.postalCode | append: ' ' }}</span>
-        {% endif %}
-        {% if cv.basics.location.countryCode %}
-          <span class="countryCode">{{ cv.basics.location.countryCode }}</span>
-        {% endif %}
-      </address>
-    </div>
-  </div>
+{% if cv.basics.summary %}
+  <div class="summary">
+    {{ cv.basics.summary | markdownify }}
+  </div>
+{% endif %}
+
+<div id="contact" class="entry">
+  <header class="entry-header">
+    <h3 class="entry-title">Contact</h3>
+  </header>
+
+  <div class="entry-content">
+    {% if cv.basics.email %}
+      <div class="email"><strong>Email</strong> <a href="mailto:{{ cv.basics.email }}">{{ cv.basics.email }}</a></div>
+    {% endif %}
+    {% if cv.basics.phone %}
+      <div class="phone"><strong>Phone</strong> {{ cv.basics.phone }}</div>
+    {% endif %}
+    {% if cv.basics.website %}
+      <div class="website"><strong>Website</strong> <a href="{{ cv.basics.website }}">{{ cv.basics.website }}</a></div>
+    {% endif %}
+    {% if cv.basics.profiles %}
+      {% for p in cv.basics.profiles %}
+        <div class="item">
+          {% if p.network %}
+            <strong class="network">{{ p.network | append: ' ' }}</strong>
+          {% endif %}
+          {% if p.username %}
+            <span class="username">
+              {% unless p.url == '' or p.url == nil %}
+                <a href="{{ p.url }}">{{ p.username }}</a>
+              {% else %}
+                {{ p.username }}
+              {% endunless %}
+            </span>
+          {% endif %}
+        </div>
+      {% endfor %}
+    {% endif %}
+  </div>
+</div>
+
+{% if cv.basics.location %}
+  <div id="location" class="entry">
+    <header class="entry-header">
+      <h3 class="entry-title">Location</h3>
+    </header>
+
+    <div class="entry-content">
+      <address>
+        {% if cv.basics.location.address %}
+          <span class="address">{{ cv.basics.location.address }}</span><br />
+        {% endif %}
+        {% if cv.basics.location.city %}
+          <span class="city">{{ cv.basics.location.city | append: ', ' }}</span>
+        {% endif %}
+        {% if cv.basics.location.region %}
+          <span class="region">{{ cv.basics.location.region | append: ' ' }}</span>
+        {% endif %}
+        {% if cv.basics.location.postalCode %}
+          <span class="postalCode">{{ cv.basics.location.postalCode | append: ' ' }}</span>
+        {% endif %}
+        {% if cv.basics.location.countryCode %}
+          <span class="countryCode">{{ cv.basics.location.countryCode }}</span>
+        {% endif %}
+      </address>
+    </div>
+  </div>
 {% endif %}