jekyll-theme-so-simple 3.0.1 → 3.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: c1caee5e5e9fa8db7932658d15b925dfad342dee
4
- data.tar.gz: 7b021fb379e18da026f29481eb5680446ffb5be2
3
+ metadata.gz: c1eef395cd243a00dc87c5ee1a4d5db721896938
4
+ data.tar.gz: 0fec102298b6e83b1ba8a528b5ce44abd15424ed
5
5
  SHA512:
6
- metadata.gz: aee5c4db0af96415e90e7f10ad77018184733a4f1695351426a76222e9b2e642e4335029bf48969c807f6aa52e3a145863e1ed23d465540025589c57e2b07e54
7
- data.tar.gz: 6fd328595737a8a9da3fa73ecdefe5ae24705cb3904ed7f3c46b86d5f062cfa7d8c0f207824887c1ede396bb99407a599be10f65a473ce636759dbee66823ea3
6
+ metadata.gz: e0d84f44ea507a9525dcba50e8a4a6d670d8d74e9344675320aab46f9ea8a9719015f512627c36a70477a2c938e34fe13e6fe95a232375e0e0805a74adc40092
7
+ data.tar.gz: d4f80fece7857fb9e593fc4f6ebeba22be095a3603def390ad7c9322e24980d3a5fc70c2e7db4dec44554512cd04111da4735d728a98bae4d5dad7c8eb7e41ff
@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](http://keepachangelog.com/)
6
6
  and this project adheres to [Semantic Versioning](http://semver.org/).
7
7
 
8
+ ## [3.1.0] - 03-12-2018
9
+
10
+ ### Changed
11
+ - Set `autofocus` on search input.
12
+ - Update Font Awesome to version [`5.0.7`](https://github.com/FortAwesome/Font-Awesome/blob/master/CHANGELOG.md).
13
+
14
+ ### Added
15
+ - Add `posts_limit` override to `home` layout to set how many posts are shown (when not using pagination).
16
+ - Add `hidden: true` test post to verify it is excluded from home page pagination.
17
+ - Add note about disabling footer links with `footer_links: false`.
18
+ - Add support for sorting collections by `date` or `title`. [#272](https://github.com/mmistakes/so-simple-theme/pull/272)
19
+
20
+ ### Fixed
21
+ - Fix `remote_theme` name in README documentation. [#268](https://github.com/mmistakes/so-simple-theme/pull/268)
22
+
8
23
  ## [3.0.1] - 02-06-2018
9
24
 
10
25
  ### Fixed
data/README.md CHANGED
@@ -1,6 +1,9 @@
1
1
  # [So Simple Jekyll Theme][1]
2
2
 
3
- [![Gem](https://img.shields.io/gem/v/jekyll-theme-so-simple.svg?style=flat-square)](https://rubygems.org/gems/jekyll-theme-so-simple)
3
+ [![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat-square)](https://raw.githubusercontent.com/mmistakes/so-simple-theme/master/LICENSE)
4
+ [![Jekyll](https://img.shields.io/badge/jekyll-%3E%3D%203.6-blue.svg?style=flat-square)](https://jekyllrb.com/)
5
+ [![Ruby gem](https://img.shields.io/gem/v/jekyll-theme-so-simple.svg?style=flat-square)](https://rubygems.org/gems/jekyll-theme-so-simple)
6
+ [![Tip Me via PayPal](https://img.shields.io/badge/PayPal-tip%20me-green.svg?style=flat-square&logo=paypal)](https://www.paypal.me/mmistakes)
4
7
 
5
8
  So Simple is a simple [Jekyll theme](https://jekyllrb.com/docs/themes/) for your words and pictures. Built to provide:
6
9
 
@@ -12,6 +15,8 @@ So Simple is a simple [Jekyll theme](https://jekyllrb.com/docs/themes/) for your
12
15
 
13
16
  :sparkles: **See what's new in the [CHANGELOG](CHANGELOG.md).**
14
17
 
18
+ :blue_book: **[v2 documentation](README-OLD.md)**.
19
+
15
20
  [![So Simple live preview][2]][1]
16
21
 
17
22
  ![So Simple layouts](screenshots.jpg)
@@ -19,6 +24,41 @@ So Simple is a simple [Jekyll theme](https://jekyllrb.com/docs/themes/) for your
19
24
  [1]: https://mmistakes.github.io/so-simple-theme/
20
25
  [2]: screenshot.png "site preview"
21
26
 
27
+ ## Sample Pages
28
+
29
+ | Description | | |
30
+ | ----------- | -- | -- |
31
+ | A post with a large hero image. | [Preview][post-hero-preview] | [Source][post-hero-source] |
32
+ | 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] |
33
+ | Post displaying highlighted code. | [Preview][post-syntax-preview] | [Source][post-syntax-code] |
34
+ | A post displaying images with a variety of alignments. | [Preview][post-image-alignment-preview] | [Source][post-image-alignment-source] |
35
+ | All posts grouped by year. | [Preview][posts-year-preview] | [Source][posts-year-source] |
36
+ | All posts grouped by category. | [Preview][posts-category-preview] | [Source][posts-category-source] |
37
+ | All posts grouped by tag. | [Preview][posts-tag-preview] | [Source][posts-tag-source] |
38
+ | Category page. | [Preview][category-page-preview] | [Source][category-page-source] |
39
+ | Listing of documents in grid view. | [Preview][grid-view-preview] | [Source][grid-view-source] |
40
+
41
+ [post-hero-preview]: https://mmistakes.github.io/so-simple-theme/layout/layout-hero-image/
42
+ [post-hero-source]: docs/_posts/2012-03-14-layout-hero-image.md
43
+ [post-html-elements-preview]: https://mmistakes.github.io/so-simple-theme/markup/markup-html-elements-and-formatting/
44
+ [post-html-elements-source]: docs/_posts/2013-01-11-markup-html-elements-and-formatting.md
45
+ [post-syntax-preview]: https://mmistakes.github.io/so-simple-theme/markup-syntax-highlighting/
46
+ [post-syntax-code]: docs/_posts/2013-08-16-markup-syntax-highlighting.md
47
+ [post-image-alignment-preview]: https://mmistakes.github.io/so-simple-theme/markup/markup-image-alignment/
48
+ [post-image-alignment-source]: docs/_posts/2013-01-10-markup-image-alignment.md
49
+ [posts-year-preview]: https://mmistakes.github.io/so-simple-theme/posts/
50
+ [posts-year-source]: docs/posts.md
51
+ [posts-category-preview]: https://mmistakes.github.io/so-simple-theme/categories/
52
+ [posts-category-source]: docs/categories.md
53
+ [posts-tag-preview]: https://mmistakes.github.io/so-simple-theme/tags/
54
+ [posts-tag-source]: docs/tags.md
55
+ [category-page-preview]: https://mmistakes.github.io/so-simple-theme/categories/edge-case/
56
+ [category-page-source]: docs/edge-case.md
57
+ [grid-view-preview]: https://mmistakes.github.io/so-simple-theme/recipes/
58
+ [grid-view-source]: docs/recipes.md
59
+
60
+ 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.
61
+
22
62
  ## Table of Contents
23
63
 
24
64
  1. [Installation](#installation)
@@ -128,7 +168,7 @@ GitHub Pages has added [full support](https://github.com/blog/2464-use-any-theme
128
168
 
129
169
  2. Run `bundle update` and verify that all gems install properly.
130
170
 
131
- 3. Add `remote_theme: "mmistakes/jekyll-theme-so-simple"` to your
171
+ 3. Add `remote_theme: "mmistakes/so-simple-theme"` to your
132
172
  `_config.yml` file. Remove any other `theme:` or `remote_theme:` entries.
133
173
 
134
174
  ---
@@ -484,7 +524,7 @@ This layout accommodates the following front matter:
484
524
  image:
485
525
  path: /images/post-image-lg.jpg
486
526
  thumbnail: /images/post-image-th.jpg
487
- caption: "Photo credit [Unsplash](https://unsplash.com/)
527
+ caption: "Photo credit [Unsplash](https://unsplash.com/)"
488
528
  ```
489
529
 
490
530
  **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
564
604
  entries_layout: # list (default), grid
565
605
  ```
566
606
 
567
- 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).
607
+ 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.
568
608
 
569
- ```liquid
570
- {% for entry in site.posts limit: 10 %}
571
- {% include entry.html %}
572
- {% endfor %}
609
+ ```yaml
610
+ posts_limit: 5
573
611
  ```
574
612
 
575
613
  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
599
637
  ```yaml
600
638
  collection: # collection name
601
639
  entries_layout: # list (default), grid
640
+ show_excerpts: # true (default), false
641
+ sort_by: # date (default) title
642
+ sort_order: # forward (default), reverse
602
643
  ```
603
644
 
604
645
  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/
610
651
  collection: recipes
611
652
  ```
612
653
 
613
- 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.
654
+ 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`.
614
655
 
615
656
  ### `layout: category`
616
657
 
@@ -783,6 +824,8 @@ footer_links:
783
824
  icon: fas fa-rss-square
784
825
  ```
785
826
 
827
+ **Note:** To disable footer links completely use `footer_links: false`.
828
+
786
829
  ### Copyright Text
787
830
 
788
831
  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):
@@ -1,3 +1,19 @@
1
- {%- for entry in site[include.collection] -%}
1
+ {% assign entries = site[include.collection] %}
2
+
3
+ {% if include.sort_by == 'title' %}
4
+ {% if include.sort_order == 'reverse' %}
5
+ {% assign entries = entries | sort: 'title' | reverse %}
6
+ {% else %}
7
+ {% assign entries = entries | sort: 'title' %}
8
+ {% endif %}
9
+ {% elsif include.sort_by == 'date' %}
10
+ {% if include.sort_order == 'reverse' %}
11
+ {% assign entries = entries | sort: 'date' | reverse %}
12
+ {% else %}
13
+ {% assign entries = entries | sort: 'date' %}
14
+ {% endif %}
15
+ {% endif %}
16
+
17
+ {%- for entry in entries -%}
2
18
  {% include entry.html %}
3
19
  {%- endfor -%}
@@ -1,3 +1,5 @@
1
- {%- for entry in site.posts limit: 10 -%}
2
- {% include entry.html %}
3
- {%- endfor -%}
1
+ {% assign posts_limit = page.posts_limit | default: 10 %}
2
+
3
+ {%- for entry in site.posts limit: posts_limit -%}
4
+ {% include entry.html %}
5
+ {%- endfor -%}
@@ -10,7 +10,7 @@
10
10
  {%- else -%}
11
11
  <script src="https://code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
12
12
  <script src="{{ '/assets/js/main.min.js' | relative_url }}"></script>
13
- <script src="https://use.fontawesome.com/releases/v5.0.6/js/all.js"></script>
13
+ <script src="https://use.fontawesome.com/releases/v5.0.7/js/all.js"></script>
14
14
  {%- endif -%}
15
15
 
16
16
 
@@ -5,5 +5,5 @@ layout: page
5
5
  {{ content }}
6
6
 
7
7
  <div class="entries-{{ page.entries_layout | default: 'list' }}">
8
- {% include documents-collection.html collection=page.collection %}
8
+ {% include documents-collection.html collection=page.collection sort_by=page.sort_by sort_order=page.sort_order %}
9
9
  </div>
@@ -1,6 +1,6 @@
1
1
  <!DOCTYPE html>
2
2
  <!--
3
- So Simple Jekyll Theme 3.0.1
3
+ So Simple Jekyll Theme 3.1.0
4
4
  Copyright 2013-2018 Michael Rose - mademistakes.com | @mmistakes
5
5
  Free for personal and commercial use under the MIT license
6
6
  https://github.com/mmistakes/so-simple-theme/blob/master/LICENSE
@@ -1,11 +1,11 @@
1
- ---
2
- layout: page
3
- ---
4
-
5
- {{ content }}
6
-
7
- <form>
8
- <input type="input" id="search" class="search-input" placeholder="{{ site.data.text[site.locale].search_placeholder_text | default: 'Enter your search term...' }}" />
9
- </form>
10
-
11
- <div id="results"></div>
1
+ ---
2
+ layout: page
3
+ ---
4
+
5
+ {{ content }}
6
+
7
+ <form>
8
+ <input type="input" id="search" class="search-input" placeholder="{{ site.data.text[site.locale].search_placeholder_text | default: 'Enter your search term...' }}" autofocus>
9
+ </form>
10
+
11
+ <div id="results"></div>
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * So Simple Jekyll Theme 3.0.1
2
+ * So Simple Jekyll Theme 3.1.0
3
3
  * Copyright 2013-2018 Michael Rose - mademistakes.com | @mmistakes
4
4
  * Free for personal and commercial use under the MIT license
5
5
  * https://github.com/mmistakes/so-simple-theme/blob/master/LICENSE
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * So Simple Jekyll Theme 3.0.1 by Michael Rose
2
+ * So Simple Jekyll Theme 3.1.0 by Michael Rose
3
3
  * Copyright 2013-2018 Michael Rose - mademistakes.com | @mmistakes
4
4
  * Licensed under MIT
5
5
  */
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-so-simple
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.1
4
+ version: 3.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Michael Rose
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-02-06 00:00:00.000000000 Z
11
+ date: 2018-03-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll