jekyll-theme-so-simple 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1caee5e5e9fa8db7932658d15b925dfad342dee
-  data.tar.gz: 7b021fb379e18da026f29481eb5680446ffb5be2
+  metadata.gz: c1eef395cd243a00dc87c5ee1a4d5db721896938
+  data.tar.gz: 0fec102298b6e83b1ba8a528b5ce44abd15424ed
 SHA512:
-  metadata.gz: aee5c4db0af96415e90e7f10ad77018184733a4f1695351426a76222e9b2e642e4335029bf48969c807f6aa52e3a145863e1ed23d465540025589c57e2b07e54
-  data.tar.gz: 6fd328595737a8a9da3fa73ecdefe5ae24705cb3904ed7f3c46b86d5f062cfa7d8c0f207824887c1ede396bb99407a599be10f65a473ce636759dbee66823ea3
+  metadata.gz: e0d84f44ea507a9525dcba50e8a4a6d670d8d74e9344675320aab46f9ea8a9719015f512627c36a70477a2c938e34fe13e6fe95a232375e0e0805a74adc40092
+  data.tar.gz: d4f80fece7857fb9e593fc4f6ebeba22be095a3603def390ad7c9322e24980d3a5fc70c2e7db4dec44554512cd04111da4735d728a98bae4d5dad7c8eb7e41ff

data/CHANGELOG.md

@@ -5,6 +5,21 @@ 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/).
 
+## [3.1.0] - 03-12-2018
+
+### Changed
+- Set `autofocus` on search input.
+- Update Font Awesome to version [`5.0.7`](https://github.com/FortAwesome/Font-Awesome/blob/master/CHANGELOG.md).
+
+### Added
+- Add `posts_limit` override to `home` layout to set how many posts are shown (when not using pagination).
+- Add `hidden: true` test post to verify it is excluded from home page pagination.
+- Add note about disabling footer links with `footer_links: false`.
+- Add support for sorting collections by `date` or `title`. [#272](https://github.com/mmistakes/so-simple-theme/pull/272)
+
+### Fixed
+- Fix `remote_theme` name in README documentation. [#268](https://github.com/mmistakes/so-simple-theme/pull/268)
+
 ## [3.0.1] - 02-06-2018
 
 ### Fixed

data/README.md

@@ -1,6 +1,9 @@
 # [So Simple Jekyll Theme][1]
 
-[![Gem](https://img.shields.io/gem/v/jekyll-theme-so-simple.svg?style=flat-square)](https://rubygems.org/gems/jekyll-theme-so-simple)
+[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat-square)](https://raw.githubusercontent.com/mmistakes/so-simple-theme/master/LICENSE)
+[![Jekyll](https://img.shields.io/badge/jekyll-%3E%3D%203.6-blue.svg?style=flat-square)](https://jekyllrb.com/)
+[![Ruby gem](https://img.shields.io/gem/v/jekyll-theme-so-simple.svg?style=flat-square)](https://rubygems.org/gems/jekyll-theme-so-simple)
+[![Tip Me via PayPal](https://img.shields.io/badge/PayPal-tip%20me-green.svg?style=flat-square&logo=paypal)](https://www.paypal.me/mmistakes)
 
 So Simple is a simple [Jekyll theme](https://jekyllrb.com/docs/themes/) for your words and pictures. Built to provide:
 
@@ -12,6 +15,8 @@ So Simple is a simple [Jekyll theme](https://jekyllrb.com/docs/themes/) for your
 
 :sparkles: **See what's new in the [CHANGELOG](CHANGELOG.md).**
 
+:blue_book: **[v2 documentation](README-OLD.md)**.
+
 [![So Simple live preview][2]][1]
 
 ![So Simple layouts](screenshots.jpg)
@@ -19,6 +24,41 @@ So Simple is a simple [Jekyll theme](https://jekyllrb.com/docs/themes/) for your
 [1]: https://mmistakes.github.io/so-simple-theme/
 [2]: screenshot.png "site preview"
 
+## Sample Pages
+
+| Description |    |    |
+| ----------- | -- | -- |
+| A post with a large hero image. | [Preview][post-hero-preview] | [Source][post-hero-source] |
+| A post with a variety of common HTML elements showing how the theme styles them. | [Preview][post-html-elements-preview] | [Source][post-html-elements-source] |
+| Post displaying highlighted code. | [Preview][post-syntax-preview] | [Source][post-syntax-code] |
+| A post displaying images with a variety of alignments. | [Preview][post-image-alignment-preview] | [Source][post-image-alignment-source] |
+| All posts grouped by year. | [Preview][posts-year-preview] | [Source][posts-year-source] |
+| All posts grouped by category. | [Preview][posts-category-preview] | [Source][posts-category-source] |
+| All posts grouped by tag. | [Preview][posts-tag-preview] | [Source][posts-tag-source] |
+| Category page. | [Preview][category-page-preview] | [Source][category-page-source] |
+| Listing of documents in grid view. | [Preview][grid-view-preview] | [Source][grid-view-source] |
+
+[post-hero-preview]: https://mmistakes.github.io/so-simple-theme/layout/layout-hero-image/
+[post-hero-source]: docs/_posts/2012-03-14-layout-hero-image.md
+[post-html-elements-preview]: https://mmistakes.github.io/so-simple-theme/markup/markup-html-elements-and-formatting/
+[post-html-elements-source]: docs/_posts/2013-01-11-markup-html-elements-and-formatting.md
+[post-syntax-preview]: https://mmistakes.github.io/so-simple-theme/markup-syntax-highlighting/
+[post-syntax-code]: docs/_posts/2013-08-16-markup-syntax-highlighting.md
+[post-image-alignment-preview]: https://mmistakes.github.io/so-simple-theme/markup/markup-image-alignment/
+[post-image-alignment-source]: docs/_posts/2013-01-10-markup-image-alignment.md
+[posts-year-preview]: https://mmistakes.github.io/so-simple-theme/posts/
+[posts-year-source]: docs/posts.md
+[posts-category-preview]: https://mmistakes.github.io/so-simple-theme/categories/
+[posts-category-source]: docs/categories.md
+[posts-tag-preview]: https://mmistakes.github.io/so-simple-theme/tags/
+[posts-tag-source]: docs/tags.md
+[category-page-preview]: https://mmistakes.github.io/so-simple-theme/categories/edge-case/
+[category-page-source]: docs/edge-case.md
+[grid-view-preview]: https://mmistakes.github.io/so-simple-theme/recipes/
+[grid-view-source]: docs/recipes.md
+
+Additional [sample posts](https://mmistakes.github.io/so-simple-theme/posts/) can be view on the demo site. Source files for these (and the entire demo site) can be found in [`/docs`](docs) folder.
+
 ## Table of Contents
 
 1. [Installation](#installation)
@@ -128,7 +168,7 @@ GitHub Pages has added [full support](https://github.com/blog/2464-use-any-theme
 
 2. Run `bundle update` and verify that all gems install properly.
 
-3. Add `remote_theme: "mmistakes/jekyll-theme-so-simple"` to your
+3. Add `remote_theme: "mmistakes/so-simple-theme"` to your
    `_config.yml` file. Remove any other `theme:` or `remote_theme:` entries.
 
 ---
@@ -484,7 +524,7 @@ This layout accommodates the following front matter:
 image:
   path: /images/post-image-lg.jpg
   thumbnail: /images/post-image-th.jpg
-  caption: "Photo credit [Unsplash](https://unsplash.com/)
+  caption: "Photo credit [Unsplash](https://unsplash.com/)"
 ```
 
 **Note:** `image.feature` front matter has been deprecated, to fully support [jekyll-seo-tag][jekyll-seo-tag]. If you are not using `thumbnail` or `caption` the post image can be assigned more concisely as `image: /images/your-post-image.jpg`.
@@ -564,12 +604,10 @@ paginate: true  # enables pagination loop, see section above for additional setu
 entries_layout: # list (default), grid
 ```
 
-When not enabled the page defaults to showing the latest 10 posts. To change the amount of posts shown, you can edit or override the `limit` value in [`/_includes/posts-limit.html`](_includes/posts-limit.html).
+When pagination is not enabled the page defaults to showing the latest 10 posts. To change the amount of posts shown, assign a limit value by adding the following to the page's front matter.
 
-```liquid
-{% for entry in site.posts limit: 10 %}
-  {% include entry.html %}
-{% endfor %}
+```yaml
+posts_limit: 5
 ```
 
 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.
@@ -599,6 +637,9 @@ This layout displays all documents grouped by a specific collection. It accommod
 ```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:
@@ -610,7 +651,7 @@ 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.
+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`. If you are simply looking for a list that shows recipe titles (no excerpts), add `show_excerpts: false`.
 
 ### `layout: category`
 
@@ -783,6 +824,8 @@ footer_links:
     icon: fas fa-rss-square
 ```
 
+**Note:** To disable footer links completely use `footer_links: false`.
+
 ### Copyright Text
 
 By default the copyright inserts the current year, [`site.title`](#site-title), and the words `"Powered by Jekyll & So Simple."` To change this add `copyright` to your `_config.yml` like so (Markdown is allowed):

data/_includes/documents-collection.html

@@ -1,3 +1,19 @@
-{%- for entry in site[include.collection] -%}
+{% assign entries = site[include.collection] %}
+
+{% if include.sort_by == 'title' %}
+  {% if include.sort_order == 'reverse' %}
+    {% assign entries = entries | sort: 'title' | reverse %}
+  {% else %}
+    {% assign entries = entries | sort: 'title' %}
+  {% endif %}
+{% elsif include.sort_by == 'date' %}
+  {% if include.sort_order == 'reverse' %}
+    {% assign entries = entries | sort: 'date' | reverse %}
+  {% else %}
+    {% assign entries = entries | sort: 'date' %}
+  {% endif %}
+{% endif %}
+
+{%- for entry in entries -%}
   {% include entry.html %}
 {%- endfor -%}

data/_includes/posts-limit.html

@@ -1,3 +1,5 @@
-{%- for entry in site.posts limit: 10 -%}
-  {% include entry.html %}
-{%- endfor -%}
+{% assign posts_limit = page.posts_limit | default: 10 %}
+
+{%- for entry in site.posts limit: posts_limit -%}
+  {% include entry.html %}
+{%- endfor -%}

data/_includes/scripts.html

@@ -10,7 +10,7 @@
 {%- else -%}
   <script src="https://code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
   <script src="{{ '/assets/js/main.min.js' | relative_url }}"></script>
-  <script src="https://use.fontawesome.com/releases/v5.0.6/js/all.js"></script>
+  <script src="https://use.fontawesome.com/releases/v5.0.7/js/all.js"></script>
 {%- endif -%}
 
 

data/_layouts/collection.html

@@ -5,5 +5,5 @@ layout: page
 {{ content }}
 
 <div class="entries-{{ page.entries_layout | default: 'list' }}">
-  {% include documents-collection.html collection=page.collection %}
+  {% include documents-collection.html collection=page.collection sort_by=page.sort_by sort_order=page.sort_order %}
 </div>

data/_layouts/default.html

@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 <!--
-    So Simple Jekyll Theme 3.0.1
+    So Simple Jekyll Theme 3.1.0
     Copyright 2013-2018 Michael Rose - mademistakes.com | @mmistakes
     Free for personal and commercial use under the MIT license
     https://github.com/mmistakes/so-simple-theme/blob/master/LICENSE

data/_layouts/search.html

@@ -1,11 +1,11 @@
----
-layout: page
----
-
-{{ content }}
-
-<form>
-  <input type="input" id="search" class="search-input" placeholder="{{ site.data.text[site.locale].search_placeholder_text | default: 'Enter your search term...' }}" />
-</form>
-
-<div id="results"></div>
+---
+layout: page
+---
+
+{{ content }}
+
+<form>
+  <input type="input" id="search" class="search-input" placeholder="{{ site.data.text[site.locale].search_placeholder_text | default: 'Enter your search term...' }}" autofocus>
+</form>
+
+<div id="results"></div>

data/_sass/so-simple.scss

@@ -1,5 +1,5 @@
 /*!
- * So Simple Jekyll Theme 3.0.1
+ * So Simple Jekyll Theme 3.1.0
  * Copyright 2013-2018 Michael Rose - mademistakes.com | @mmistakes
  * Free for personal and commercial use under the MIT license
  * https://github.com/mmistakes/so-simple-theme/blob/master/LICENSE

data/assets/js/main.min.js

@@ -1,5 +1,5 @@
 /*!
- * So Simple Jekyll Theme 3.0.1 by Michael Rose
+ * So Simple Jekyll Theme 3.1.0 by Michael Rose
  * Copyright 2013-2018 Michael Rose - mademistakes.com | @mmistakes
  * Licensed under MIT
  */

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-so-simple
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Michael Rose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll