jekyll-wren 0.4 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE.md +9 -9
  3. data/README.md +180 -177
  4. data/_includes/custom-foot.html +4 -4
  5. data/_includes/custom-head.html +13 -13
  6. data/_includes/custom-meta.html +5 -5
  7. data/_includes/footer.html +23 -23
  8. data/_includes/head.html +21 -21
  9. data/_includes/meta.html +82 -82
  10. data/_includes/navigation.html +70 -70
  11. data/_includes/reading-time.html +41 -41
  12. data/_includes/social-list.html +46 -46
  13. data/_includes/video-player.html +66 -66
  14. data/_layouts/author-list.html +73 -73
  15. data/_layouts/default.html +16 -16
  16. data/_layouts/error.html +9 -9
  17. data/_layouts/page.html +14 -14
  18. data/_layouts/post-list.html +67 -67
  19. data/_layouts/post.html +16 -16
  20. data/_layouts/tag-list.html +54 -54
  21. data/_sass/wren/content.scss +345 -345
  22. data/_sass/wren/initialize.scss +118 -118
  23. data/_sass/wren/layout.scss +295 -295
  24. data/assets/flav.svg +4 -4
  25. data/assets/nav-icons/about.svg +2 -2
  26. data/assets/nav-icons/blog.svg +2 -2
  27. data/assets/nav-icons/comments.svg +3 -3
  28. data/assets/nav-icons/default.svg +2 -2
  29. data/assets/nav-icons/home.svg +4 -4
  30. data/assets/nav-icons/rss.svg +2 -2
  31. data/assets/nav-icons/top.svg +2 -2
  32. data/assets/nav-icons/work.svg +4 -4
  33. data/assets/social-icons/Blogger.svg +3 -3
  34. data/assets/social-icons/Blogspot.svg +3 -0
  35. data/assets/social-icons/DEV.svg +3 -3
  36. data/assets/social-icons/Default.svg +3 -3
  37. data/assets/social-icons/Dribbble.svg +3 -3
  38. data/assets/social-icons/Facebook.svg +3 -3
  39. data/assets/social-icons/Flickr.svg +3 -3
  40. data/assets/social-icons/Ghost.svg +3 -3
  41. data/assets/social-icons/GitHub.svg +3 -3
  42. data/assets/social-icons/GitLab.svg +3 -3
  43. data/assets/social-icons/HowLongToBeat.svg +3 -0
  44. data/assets/social-icons/Instagram.svg +5 -5
  45. data/assets/social-icons/Keybase.svg +6 -6
  46. data/assets/social-icons/LinkedIn.svg +3 -3
  47. data/assets/social-icons/Mastodon.svg +3 -3
  48. data/assets/social-icons/Medium.svg +5 -5
  49. data/assets/social-icons/Micro.blog.svg +3 -3
  50. data/assets/social-icons/Pinterest.svg +3 -3
  51. data/assets/social-icons/Reddit.svg +3 -3
  52. data/assets/social-icons/StackOverflow.svg +3 -3
  53. data/assets/social-icons/StoryGraph.svg +6 -0
  54. data/assets/social-icons/Strava.svg +4 -0
  55. data/assets/social-icons/Telegram.svg +3 -3
  56. data/assets/social-icons/Tumblr.svg +3 -3
  57. data/assets/social-icons/Twitter.svg +3 -3
  58. data/assets/social-icons/Wordpress.svg +4 -4
  59. data/assets/social-icons/Wren.svg +3 -0
  60. data/assets/social-icons/YouTube.svg +3 -3
  61. data/assets/style.scss +14 -14
  62. data/errors/400.md +9 -9
  63. data/errors/403.md +9 -9
  64. data/errors/404.md +9 -9
  65. data/errors/418.md +12 -12
  66. data/errors/500.md +9 -9
  67. metadata +9 -8
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 880063b3f3f71125016ffc145ad9c1928d83a3b101de7ce4b8331f1a37080d71
4
- data.tar.gz: 79f38b62a4c74603e458b7a5c385a084c91b8add5aa9ec1fa13f8f96c6229791
3
+ metadata.gz: e7414bf94321f7a7732cd746b789fb4f6eb0d75c929feb6b7e56f16b14b1e70c
4
+ data.tar.gz: c4786d2f073e8869ebbd53dc9ee0eefc8e21f005ba2e29e847bdbaa15ac33e90
5
5
  SHA512:
6
- metadata.gz: 555cfb22eea2cde9883d0fea0fdf78da7a435771b37623d3d229f858f238e130d7db845ad44b2e8293200acbdcf40bbdbe76d3ac7a22c12e828f87f3a44a9af0
7
- data.tar.gz: 61aabed58c5665fe218f7397de35d00e89c914b4a34404b9b33fecbe02e46b27181c83770753e0ff1667a1ea8eea6e5e012f2dc76469b82ac5b125b1476fd04e
6
+ metadata.gz: b678bc2df1ae9e0325258a93a5226cf9eff48509626d231cb7e005bb46e5429295d64078a1cae4abcbf3ca4a4a1db432cebc5d4d8cfa54aba358ac56a3ebb812
7
+ data.tar.gz: 9fd1093001b3de397a2b28c5a2464c5baa9a0d09e4927ecaaae7d1216c755bf458291b400c193df3adc9c7f6686ebb16bdb31b817af7a231ed9687aa3560e0a2
data/LICENSE.md CHANGED
@@ -1,9 +1,9 @@
1
- # MIT License
2
-
3
- Copyright (c) 2021 Josh Fogg
4
-
5
- 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:
6
-
7
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8
-
9
- 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.
1
+ # MIT License
2
+
3
+ Copyright (c) 2021 Josh Fogg
4
+
5
+ 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:
6
+
7
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8
+
9
+ 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 CHANGED
@@ -1,177 +1,180 @@
1
- # Wren
2
-
3
- [![Jekyll CI Status]][jekyll-ci-link]
4
- [![CodeFactor Rating]][codefactor-link]
5
- [![MIT Licensed]][license-link]
6
-
7
- [Jekyll CI Status]: https://img.shields.io/github/workflow/status/Foggalong/Wren/Jekyll%20CI?label=Jekyll%20CI
8
- [jekyll-ci-link]: https://github.com/Foggalong/Wren/actions/workflows/codeql-analysis.yml
9
- [CodeFactor Rating]: https://img.shields.io/codefactor/grade/github/foggalong/wren/main?color&label=CodeFactor
10
- [codefactor-link]: https://www.codefactor.io/repository/github/foggalong/wren
11
- [MIT Licensed]: https://img.shields.io/badge/License-MIT-brightgreen.svg
12
- [license-link]: #licenses
13
-
14
- A paper-style theme for [Jekyll]. Check out the GitHub pages [deployment] to see what the default looks like and read on for information on usage and customisation. Be aware that this **beta** software so will contain bugs; use it at your own risk.
15
-
16
- [Jekyll]: https://jekyllrb.com
17
- [deployment]: https://foggalong.github.io/Wren
18
- [wiki]: https://github.com/Foggalong/Wren/wiki
19
-
20
- ## Features
21
-
22
- - 🎨 Responsive, [customisable] design
23
- - 🕔 See post reading time
24
- - 🗄️ 'First published on' icons
25
- - 🏷️ Browse posts by tags
26
- - 🧑 Browse posts by author
27
- - 📺 Embedded [YouTube, Twitch, etc][videos]
28
- - 🦶🏼 [Extendable] head, foot, and post meta
29
- - 📃 Optional [pagination]
30
- - 📰 Atom/RSS feed of posts
31
- - 📈 In-built search engine optimization
32
-
33
- [customisable]: #custom-styling
34
- [videos]: https://foggalong.github.io/Wren/video-embed-demo
35
- [extendable]: #custom-templates
36
- [pagination]: #pagination
37
-
38
- ## Installing
39
-
40
- Whether you fork this repo or start from scratch there are two supported options for using Wren as your theme. Which works better for you will depend on your personal priorities.
41
-
42
- ### Theme Gem
43
-
44
- Use the `jekyll-wren` gem, fetched automatically from [RubyGems] or downloaded from the [releases page] and installed locally. Either way you'll need to add
45
-
46
- ```yaml
47
- theme: jekyll-wren
48
- ```
49
-
50
- to your [config] and
51
-
52
- ```ruby
53
- gem "jekyll-wren", "~> 0.4"
54
- ```
55
-
56
- to your [Gemfile] plugins list.
57
-
58
- The upsides are that builds will be quicker and you'll have more control over the version through the Gemfile. The downside is that it will prevent building with GitHub Pages' builder since Wren isn't on the [whitelist] (though you'll still be able to build locally and push to a GitHub pages branch/repo).
59
-
60
- [RubyGems]: https://rubygems.org
61
- [releases page]: https://github.com/Foggalong/Wren/releases/latest
62
- [config]: https://github.com/Foggalong/Wren/blob/main/_config.yml#L22-L23
63
- [Gemfile]: https://github.com/Foggalong/Wren/blob/main/Gemfile#L22-L28
64
-
65
- ### Remote Theme
66
-
67
- It's possible to use the theme directly from this repo. You'll need to add
68
-
69
- ```yaml
70
- plugins:
71
- - jekyll-remote-theme
72
-
73
- remote_theme: foggalong/wren@0.4
74
- ```
75
-
76
- to your [config] and then
77
-
78
- ```ruby
79
- gem "jekyll-remote-theme", "~> 0.4"
80
- ```
81
-
82
- to your [Gemfile] plugins list.
83
-
84
- The upside is that this will work with GitHub Pages' builder ([Jekyll Remote Theme] is on the [whitelist]). The downsides are that builds will be slower and your [version control] is slightly weaker; you're tied to `HEAD` or a specific version.
85
-
86
- [Jekyll Remote Theme]: https://github.com/benbalter/jekyll-remote-theme
87
- [version control]: https://github.com/benbalter/jekyll-remote-theme#declaring-your-theme
88
-
89
- ## Config Options
90
-
91
- The [config.yml] in this repo can be used as a template for your own Wren instance. The file is thoroughly commented so it's worth having a read to know all the options available.
92
-
93
- [config.yml]: https://github.com/Foggalong/Wren/blob/main/_config.yml
94
-
95
- ## Custom Templates
96
-
97
- [Minima] has a feature which allows users to create a [_includes/custom-head.html] file which is then [included] with the rest of the head. This is a useful feature if, for example, you want your website to cover favicons for more browsers than the default setup does.
98
-
99
- [_includes/custom-head.html]: https://github.com/jekyll/minima/blob/master/_includes/custom-head.html
100
- [included]: https://github.com/jekyll/minima/blob/master/_includes/head.html#L12
101
-
102
- Wren keeps this feature and extends it so that `custom-foot.html` (displayed above the copyright notice) and `custom-meta.html` (displayed at the end of a post's meta line) can also be specified.
103
-
104
- ## Custom Styling
105
-
106
- Like [Minima] (on which Wren's [SASS] is built) there are a whole bunch of variables which you can change to personalise the theme. To do this you just add lines such as
107
-
108
- ```scss
109
- $background-color: #3d9da3;
110
- ```
111
-
112
- to [`assets/style.scss`] and you're good to go. The list of what's customisable is slightly different (and longer!) than Minima so have a look at the full list of [style variables].
113
-
114
- [Minima]: https://github.com/jekyll/minima
115
- [`assets/style.scss`]: https://github.com/Foggalong/Wren/blob/main/assets/style.scss
116
- [style variables]: https://github.com/Foggalong/Wren/blob/main/_sass/wren/initialize.scss#L10-L87
117
-
118
- ## Pagination
119
-
120
- If the following two [config.yml] lines aren't commented, Wren will use [Jekyll Paginate][Paginate] to split the posts page into multiple pages of `paginate` many posts with url `paginate_path`.
121
-
122
- ```yaml
123
- paginate: 5
124
- paginate_path: "/blog/:num"
125
- ```
126
-
127
- Note that due to [Paginate]'s technical limitations this will only happen on the main posts page, not other post lists such as the tags page. It's generally quite limited in how it works compared to [Paginate v2], but the latter isn't on the [whitelist].
128
-
129
- Another caveat is that, if you're using Paginate, the main post list page **must** have filename `index.html`; that's why in this repo it's `blog/index.html`. If you're not using Paginate though, Wren allows you to put that file anywhere and called whatever you like without problems.
130
-
131
- [Paginate v2]: https://github.com/sverrirs/jekyll-paginate-v2
132
-
133
- ## Error Pages
134
-
135
- Wren includes [`error.html`], a layout for formatting error pages; they're centered, have different spacing, and slightly different `<h1>` formatting. In [`errors/`] there are some examples; those aren't in the theme-gem (see [#25]) but to use them just copy to your website's repo. See this [tutorial] for configuring error pages on GitHub pages, Apache, and Nginx.
136
-
137
- [`error.html`]: https://github.com/Foggalong/Wren/blob/main/_layouts/error.html
138
- [`errors/`]: https://github.com/Foggalong/Wren/tree/main/errors
139
- [#25]: https://github.com/Foggalong/Wren/issues/25
140
- [tutorial]: https://jekyllrb.com/tutorials/custom-404-page
141
-
142
- ## Philosophy
143
-
144
- I ❤️ [Wrens]. They're smol, quick, and rotund. When I was little we had a family of them come nest in our garden and they sang the most brilliant songs. Oh wait? You're saying this was supposed to be the project's philosophy? Let's just just say it's to be small, fast, and round.
145
-
146
- [Wrens]: https://en.wikipedia.org/wiki/Wren
147
-
148
- ## Licenses
149
-
150
- Wren is released under the [MIT License] and is built with [Jekyll] and a whole host of other MIT licensed projects.
151
-
152
- [MIT License]: https://choosealicense.com/licenses/mit
153
-
154
- In order to remain compatible with GitHub Pages Wren only uses plugins from the [whitelist]. Massive props to [Remote Theme], [Feed], [Paginate], and [SEO] for doing their thing in the background without me needing to worry about it. Further features are achieved through [Liquid] templates, some of which are based on existing Ruby plugins. These include [Reading Time], [Embed Video], [Tag Cloud].
155
-
156
- [whitelist]: https://pages.github.com/versions
157
- [Remote Theme]: https://github.com/benbalter/jekyll-remote-theme
158
- [Feed]: https://github.com/jekyll/jekyll-feed
159
- [Paginate]: https://github.com/jekyll/jekyll-paginate
160
- [SEO]: https://github.com/jekyll/jekyll-seo-tag
161
- [Liquid]: https://github.com/Shopify/liquid
162
- [Reading Time]: https://github.com/risan/jekyll-reading-time
163
- [Embed Video]: https://github.com/nathancy/jekyll-embed-video
164
- [Tag Cloud]: https://superdevresources.com/tag-cloud-jekyll
165
-
166
- Style wise, Wren's [SASS] is forked from [Minima] which proved crucial in knowing what did and didn't need to be covered by Jekyll themes. The icons (apart from are based on designs from [Font Awesome], redrawn for the smaller form factor. Credit also to Antoine Boulanger's guide on [SVG Favicons].
167
-
168
- [SASS]: https://sass-lang.com
169
- [Font Awesome]: https://github.com/Rush/Font-Awesome-SVG-PNG
170
- [SVG Favicons]: https://link.medium.com/oDf4MMhiqjb
171
-
172
- The only part of Wren _not_ MIT licensed is the [default profile image], a [CC-BY-NC] licensed [photo] of a Bewick Wren taken by [Minette Layne].
173
-
174
- [default profile image]: images/profile-hq.jpg
175
- [photo]: https://flic.kr/p/4E9FY2
176
- [Minette Layne]: https://www.flickr.com/people/minette_layne
177
- [CC-BY-NC]: https://creativecommons.org/licenses/by-nc/2.0
1
+ # Wren
2
+
3
+ [![Jekyll CI Status]][jekyll-ci-link]
4
+ [![CodeFactor Rating]][codefactor-link]
5
+ [![Download Count]][ruby-toolbox-link]
6
+ [![MIT Licensed]][license-link]
7
+
8
+ [Jekyll CI Status]: https://github.com/Foggalong/Wren/actions/workflows/codeql-analysis.yml/badge.svg
9
+ [jekyll-ci-link]: https://github.com/Foggalong/Wren/actions/workflows/codeql-analysis.yml
10
+ [CodeFactor Rating]: https://img.shields.io/codefactor/grade/github/foggalong/wren/main?color&label=CodeFactor
11
+ [codefactor-link]: https://www.codefactor.io/repository/github/foggalong/wren
12
+ [Download Count]: https://img.shields.io/gem/dt/jekyll-wren?color=bright-green&label=Downloads
13
+ [ruby-toolbox-link]: https://www.ruby-toolbox.com/projects/jekyll-wren
14
+ [MIT Licensed]: https://img.shields.io/badge/License-MIT-brightgreen.svg
15
+ [license-link]: #licenses
16
+
17
+ A paper-style theme for [Jekyll]. Check out the GitHub pages [deployment] to see what the default looks like and read on for information on usage and customisation. Be aware that this **beta** software so will contain bugs; use it at your own risk.
18
+
19
+ [Jekyll]: https://jekyllrb.com
20
+ [deployment]: https://foggalong.github.io/Wren
21
+ [wiki]: https://github.com/Foggalong/Wren/wiki
22
+
23
+ ## Features
24
+
25
+ - 🎨 Responsive, [customisable] design
26
+ - 🕔 See post reading time
27
+ - 🗄️ 'First published on' icons
28
+ - 🏷️ Browse posts by tags
29
+ - 🧑 Browse posts by author
30
+ - 📺 Embedded [YouTube, Twitch, etc][videos]
31
+ - 🦶🏼 [Extendable] head, foot, and post meta
32
+ - 📃 Optional [pagination]
33
+ - 📰 Atom/RSS feed of posts
34
+ - 📈 In-built search engine optimization
35
+
36
+ [customisable]: #custom-styling
37
+ [videos]: https://foggalong.github.io/Wren/video-embed-demo
38
+ [extendable]: #custom-templates
39
+ [pagination]: #pagination
40
+
41
+ ## Installing
42
+
43
+ Whether you fork this repo or start from scratch there are two supported options for using Wren as your theme. Which works better for you will depend on your personal priorities.
44
+
45
+ ### Theme Gem
46
+
47
+ Use the `jekyll-wren` gem, fetched automatically from [RubyGems] or downloaded from the [releases page] and installed locally. Either way you'll need to add
48
+
49
+ ```yaml
50
+ theme: jekyll-wren
51
+ ```
52
+
53
+ to your [config] and
54
+
55
+ ```ruby
56
+ gem "jekyll-wren", "~> 0.4"
57
+ ```
58
+
59
+ to your [Gemfile] plugins list.
60
+
61
+ The upsides are that builds will be quicker and you'll have more control over the version through the Gemfile. The downside is that it will prevent building with GitHub Pages' builder since Wren isn't on the [whitelist] (though you'll still be able to build locally and push to a GitHub pages branch/repo).
62
+
63
+ [RubyGems]: https://rubygems.org
64
+ [releases page]: https://github.com/Foggalong/Wren/releases/latest
65
+ [config]: https://github.com/Foggalong/Wren/blob/main/_config.yml#L22-L23
66
+ [Gemfile]: https://github.com/Foggalong/Wren/blob/main/Gemfile#L22-L28
67
+
68
+ ### Remote Theme
69
+
70
+ It's possible to use the theme directly from this repo. You'll need to add
71
+
72
+ ```yaml
73
+ plugins:
74
+ - jekyll-remote-theme
75
+
76
+ remote_theme: foggalong/wren@0.4
77
+ ```
78
+
79
+ to your [config] and then
80
+
81
+ ```ruby
82
+ gem "jekyll-remote-theme", "~> 0.4"
83
+ ```
84
+
85
+ to your [Gemfile] plugins list.
86
+
87
+ The upside is that this will work with GitHub Pages' builder ([Jekyll Remote Theme] is on the [whitelist]). The downsides are that builds will be slower and your [version control] is slightly weaker; you're tied to `HEAD` or a specific version.
88
+
89
+ [Jekyll Remote Theme]: https://github.com/benbalter/jekyll-remote-theme
90
+ [version control]: https://github.com/benbalter/jekyll-remote-theme#declaring-your-theme
91
+
92
+ ## Config Options
93
+
94
+ The [config.yml] in this repo can be used as a template for your own Wren instance. The file is thoroughly commented so it's worth having a read to know all the options available.
95
+
96
+ [config.yml]: https://github.com/Foggalong/Wren/blob/main/_config.yml
97
+
98
+ ## Custom Templates
99
+
100
+ [Minima] has a feature which allows users to create a [_includes/custom-head.html] file which is then [included] with the rest of the head. This is a useful feature if, for example, you want your website to cover favicons for more browsers than the default setup does.
101
+
102
+ [_includes/custom-head.html]: https://github.com/jekyll/minima/blob/master/_includes/custom-head.html
103
+ [included]: https://github.com/jekyll/minima/blob/master/_includes/head.html#L12
104
+
105
+ Wren keeps this feature and extends it so that `custom-foot.html` (displayed above the copyright notice) and `custom-meta.html` (displayed at the end of a post's meta line) can also be specified.
106
+
107
+ ## Custom Styling
108
+
109
+ Like [Minima] (on which Wren's [SASS] is built) there are a whole bunch of variables which you can change to personalise the theme. To do this you just add lines such as
110
+
111
+ ```scss
112
+ $background-color: #3d9da3;
113
+ ```
114
+
115
+ to [`assets/style.scss`] and you're good to go. The list of what's customisable is slightly different (and longer!) than Minima so have a look at the full list of [style variables].
116
+
117
+ [Minima]: https://github.com/jekyll/minima
118
+ [`assets/style.scss`]: https://github.com/Foggalong/Wren/blob/main/assets/style.scss
119
+ [style variables]: https://github.com/Foggalong/Wren/blob/main/_sass/wren/initialize.scss#L10-L87
120
+
121
+ ## Pagination
122
+
123
+ If the following two [config.yml] lines aren't commented, Wren will use [Jekyll Paginate][Paginate] to split the posts page into multiple pages of `paginate` many posts with url `paginate_path`.
124
+
125
+ ```yaml
126
+ paginate: 5
127
+ paginate_path: "/blog/:num"
128
+ ```
129
+
130
+ Note that due to [Paginate]'s technical limitations this will only happen on the main posts page, not other post lists such as the tags page. It's generally quite limited in how it works compared to [Paginate v2], but the latter isn't on the [whitelist].
131
+
132
+ Another caveat is that, if you're using Paginate, the main post list page **must** have filename `index.html`; that's why in this repo it's `blog/index.html`. If you're not using Paginate though, Wren allows you to put that file anywhere and called whatever you like without problems.
133
+
134
+ [Paginate v2]: https://github.com/sverrirs/jekyll-paginate-v2
135
+
136
+ ## Error Pages
137
+
138
+ Wren includes [`error.html`], a layout for formatting error pages; they're centered, have different spacing, and slightly different `<h1>` formatting. In [`errors/`] there are some examples; those aren't in the theme-gem (see [#25]) but to use them just copy to your website's repo. See this [tutorial] for configuring error pages on GitHub pages, Apache, and Nginx.
139
+
140
+ [`error.html`]: https://github.com/Foggalong/Wren/blob/main/_layouts/error.html
141
+ [`errors/`]: https://github.com/Foggalong/Wren/tree/main/errors
142
+ [#25]: https://github.com/Foggalong/Wren/issues/25
143
+ [tutorial]: https://jekyllrb.com/tutorials/custom-404-page
144
+
145
+ ## Philosophy
146
+
147
+ I ❤️ [Wrens]. They're smol, quick, and rotund. When I was little we had a family of them come nest in our garden and they sang the most brilliant songs. Oh wait? You're saying this was supposed to be the project's philosophy? Let's just just say it's to be small, fast, and round.
148
+
149
+ [Wrens]: https://en.wikipedia.org/wiki/Wren
150
+
151
+ ## Licenses
152
+
153
+ Wren is released under the [MIT License] and is built with [Jekyll] and a whole host of other MIT licensed projects.
154
+
155
+ [MIT License]: https://choosealicense.com/licenses/mit
156
+
157
+ In order to remain compatible with GitHub Pages Wren only uses plugins from the [whitelist]. Massive props to [Remote Theme], [Feed], [Paginate], and [SEO] for doing their thing in the background without me needing to worry about it. Further features are achieved through [Liquid] templates, some of which are based on existing Ruby plugins. These include [Reading Time], [Embed Video], [Tag Cloud].
158
+
159
+ [whitelist]: https://pages.github.com/versions
160
+ [Remote Theme]: https://github.com/benbalter/jekyll-remote-theme
161
+ [Feed]: https://github.com/jekyll/jekyll-feed
162
+ [Paginate]: https://github.com/jekyll/jekyll-paginate
163
+ [SEO]: https://github.com/jekyll/jekyll-seo-tag
164
+ [Liquid]: https://github.com/Shopify/liquid
165
+ [Reading Time]: https://github.com/risan/jekyll-reading-time
166
+ [Embed Video]: https://github.com/nathancy/jekyll-embed-video
167
+ [Tag Cloud]: https://superdevresources.com/tag-cloud-jekyll
168
+
169
+ Style wise, Wren's [SASS] is forked from [Minima] which proved crucial in knowing what did and didn't need to be covered by Jekyll themes. The icons (apart from are based on designs from [Font Awesome], redrawn for the smaller form factor. Credit also to Antoine Boulanger's guide on [SVG Favicons].
170
+
171
+ [SASS]: https://sass-lang.com
172
+ [Font Awesome]: https://github.com/Rush/Font-Awesome-SVG-PNG
173
+ [SVG Favicons]: https://link.medium.com/oDf4MMhiqjb
174
+
175
+ The only part of Wren _not_ MIT licensed is the [default profile image], a [CC-BY-NC] licensed [photo] of a Bewick Wren taken by [Minette Layne].
176
+
177
+ [default profile image]: images/profile-hq.jpg
178
+ [photo]: https://flic.kr/p/4E9FY2
179
+ [Minette Layne]: https://www.flickr.com/people/minette_layne
180
+ [CC-BY-NC]: https://creativecommons.org/licenses/by-nc/2.0
@@ -1,4 +1,4 @@
1
- {% comment %}
2
- Placeholder to allow defining custom footer content.
3
- In principle, you can add anything here.
4
- {% endcomment %}
1
+ {% comment %}
2
+ Placeholder to allow defining custom footer content.
3
+ In principle, you can add anything here.
4
+ {% endcomment %}
@@ -1,13 +1,13 @@
1
- {% comment %}
2
- Placeholder to allow defining custom head. In principle, you can add
3
- anything here, e.g. favicons.
4
-
5
- If you have a website that you anticipate people using as a webapp on
6
- iOS, Android, or Windows 8 or Windows 10 then it would be worth head
7
- over to https://realfavicongenerator.net/ to add your own favicons and
8
- insetting the code snippets they give into _includes/custom-head.html
9
- in your source directory.
10
-
11
- The favicons Wren provides are the absolute minimum to cover modern
12
- browsers. See here for more info: https://link.medium.com/oDf4MMhiqjb
13
- {% endcomment %}
1
+ {% comment %}
2
+ Placeholder to allow defining custom head. In principle, you can add
3
+ anything here, e.g. favicons.
4
+
5
+ If you have a website that you anticipate people using as a webapp on
6
+ iOS, Android, or Windows 8 or Windows 10 then it would be worth head
7
+ over to https://realfavicongenerator.net/ to add your own favicons and
8
+ insetting the code snippets they give into _includes/custom-head.html
9
+ in your source directory.
10
+
11
+ The favicons Wren provides are the absolute minimum to cover modern
12
+ browsers. See here for more info: https://link.medium.com/oDf4MMhiqjb
13
+ {% endcomment %}
@@ -1,5 +1,5 @@
1
- {% comment %}
2
- Placeholder to allow defining custom meta content. In principle, you can add
3
- anything here. To keep style consistent with the rest of Wren's meta you
4
- should use '•' to separate different attributes.
5
- {% endcomment %}
1
+ {% comment %}
2
+ Placeholder to allow defining custom meta content. In principle, you can add
3
+ anything here. To keep style consistent with the rest of Wren's meta you
4
+ should use '•' to separate different attributes.
5
+ {% endcomment %}
@@ -1,23 +1,23 @@
1
- <footer class="site-footer h-card">
2
- <data class="u-url" href="{{ "/" | relative_url }}"></data>
3
- {%comment%} add user's custom footer; anything can go here! {%endcomment%}
4
- {%- include custom-foot.html -%}
5
- {%comment%} keeps copyright notice to current year {%endcomment%}
6
- Copyright © {{ site.time | date: '%Y' }}
7
- {%- if site.author %}
8
- {% if site.author.name -%}
9
- {% if site.author.email -%}
10
- <a href="mailto:{{ site.author.email }}">{{ site.author.name }}</a>
11
- {% else -%}
12
- {{ site.author.name }}
13
- {%- endif %}
14
- {%- endif %}
15
- {%- endif -%}
16
- {%comment%} remove line below if you don't want to attribute Jekyll/Wren {%endcomment%}
17
- · Made using <a href="https://jekyllrb.com">Jekyll</a> with <a href="https://github.com/Foggalong/Wren">Wren</a>
18
-
19
- {%comment%} social-list.html quite big so in a separate file {%endcomment%}
20
- <div class="social-list">
21
- {%- include social-list.html -%}
22
- </div>
23
- </footer>
1
+ <footer class="site-footer h-card">
2
+ <data class="u-url" href="{{ "/" | relative_url }}"></data>
3
+ {%comment%} add user's custom footer; anything can go here! {%endcomment%}
4
+ {%- include custom-foot.html -%}
5
+ {%comment%} keeps copyright notice to current year {%endcomment%}
6
+ Copyright © {{ site.time | date: '%Y' }}
7
+ {%- if site.author %}
8
+ {% if site.author.name -%}
9
+ {% if site.author.email -%}
10
+ <a href="mailto:{{ site.author.email }}">{{ site.author.name }}</a>
11
+ {% else -%}
12
+ {{ site.author.name }}
13
+ {%- endif %}
14
+ {%- endif %}
15
+ {%- endif -%}
16
+ {%comment%} remove line below if you don't want to attribute Jekyll/Wren {%endcomment%}
17
+ · Made using <a href="https://jekyllrb.com">Jekyll</a> with <a href="https://github.com/Foggalong/Wren">Wren</a>
18
+
19
+ {%comment%} social-list.html quite big so in a separate file {%endcomment%}
20
+ <div class="social-list">
21
+ {%- include social-list.html -%}
22
+ </div>
23
+ </footer>
data/_includes/head.html CHANGED
@@ -1,21 +1,21 @@
1
- <head>
2
- <meta charset="utf-8">
3
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
4
- <meta name="viewport" content="width=device-width, initial-scale=1">
5
- {%comment%} jekyll-seo-tag doing its thing {%endcomment%}
6
- {%- seo -%}
7
- {%comment%}
8
- using SVG favicons, see link below for documentation. In theory the flav.svg will
9
- cover all modern browsers except iOS Safari which the apple-touch-icon.png covers
10
- https://medium.com/swlh/are-you-using-svg-favicons-yet-a-guide-for-modern-browsers
11
- {%endcomment%}
12
- <link rel="icon" href="{{ '/assets/flav.svg' | relative_url }}">
13
- <link rel="shortcut icon" href="{{ '/assets/flav.svg' | relative_url }}">
14
- <link rel="apple-touch-icon" href="{{ '/assets/apple-touch-icon.png' | relative_url }}">
15
- {%comment%} assets/style.css isn't a typo, is where SASS will compile to {%endcomment%}
16
- <link rel="stylesheet" href="{{ '/assets/style.css' | relative_url }}">
17
- {%comment%} jekyll-feed doing its thing {%endcomment%}
18
- {%- feed_meta -%}
19
- {%comment%} add user's custom header; anything can go here! {%endcomment%}
20
- {%- include custom-head.html -%}
21
- </head>
1
+ <head>
2
+ <meta charset="utf-8">
3
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
4
+ <meta name="viewport" content="width=device-width, initial-scale=1">
5
+ {%comment%} jekyll-seo-tag doing its thing {%endcomment%}
6
+ {%- seo -%}
7
+ {%comment%}
8
+ using SVG favicons, see link below for documentation. In theory the flav.svg will
9
+ cover all modern browsers except iOS Safari which the apple-touch-icon.png covers
10
+ https://medium.com/swlh/are-you-using-svg-favicons-yet-a-guide-for-modern-browsers
11
+ {%endcomment%}
12
+ <link rel="icon" href="{{ '/assets/flav.svg' | relative_url }}">
13
+ <link rel="shortcut icon" href="{{ '/assets/flav.svg' | relative_url }}">
14
+ <link rel="apple-touch-icon" href="{{ '/assets/apple-touch-icon.png' | relative_url }}">
15
+ {%comment%} assets/style.css isn't a typo, is where SASS will compile to {%endcomment%}
16
+ <link rel="stylesheet" href="{{ '/assets/style.css' | relative_url }}">
17
+ {%comment%} jekyll-feed doing its thing {%endcomment%}
18
+ {%- feed_meta -%}
19
+ {%comment%} add user's custom header; anything can go here! {%endcomment%}
20
+ {%- include custom-head.html -%}
21
+ </head>