bulma-clean-theme 0.10.6 → 0.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (89) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +170 -84
  3. data/_includes/series.html +32 -0
  4. data/_includes/vimeo.html +3 -0
  5. data/_includes/youtube.html +1 -1
  6. data/_layouts/default.html +13 -12
  7. data/_layouts/post.html +4 -0
  8. data/_layouts/recipe.html +98 -0
  9. data/_posts/2021-10-30-creating-a-post-series.md +59 -0
  10. data/node_modules/.package-lock.json +26 -0
  11. data/node_modules/bulma/CHANGELOG.md +521 -448
  12. data/node_modules/bulma/README.md +5 -2
  13. data/node_modules/bulma/bulma.sass +1 -1
  14. data/node_modules/bulma/css/bulma-rtl.css +778 -591
  15. data/node_modules/bulma/css/bulma-rtl.css.map +1 -1
  16. data/node_modules/bulma/css/bulma-rtl.min.css +1 -1
  17. data/node_modules/bulma/css/bulma.css +621 -434
  18. data/node_modules/bulma/css/bulma.css.map +1 -1
  19. data/node_modules/bulma/css/bulma.min.css +1 -1
  20. data/node_modules/bulma/package.json +28 -54
  21. data/node_modules/bulma/sass/base/_all.sass +3 -2
  22. data/node_modules/bulma/sass/base/animations.sass +5 -0
  23. data/node_modules/bulma/sass/base/generic.sass +2 -0
  24. data/node_modules/bulma/sass/components/_all.sass +12 -12
  25. data/node_modules/bulma/sass/components/breadcrumb.sass +2 -0
  26. data/node_modules/bulma/sass/components/card.sass +23 -3
  27. data/node_modules/bulma/sass/components/dropdown.sass +3 -1
  28. data/node_modules/bulma/sass/components/level.sass +3 -1
  29. data/node_modules/bulma/sass/components/media.sass +16 -9
  30. data/node_modules/bulma/sass/components/menu.sass +2 -0
  31. data/node_modules/bulma/sass/components/message.sass +2 -0
  32. data/node_modules/bulma/sass/components/modal.sass +2 -0
  33. data/node_modules/bulma/sass/components/navbar.sass +3 -0
  34. data/node_modules/bulma/sass/components/pagination.sass +19 -3
  35. data/node_modules/bulma/sass/components/panel.sass +3 -1
  36. data/node_modules/bulma/sass/components/tabs.sass +2 -0
  37. data/node_modules/bulma/sass/elements/_all.sass +12 -12
  38. data/node_modules/bulma/sass/elements/box.sass +3 -1
  39. data/node_modules/bulma/sass/elements/button.sass +27 -7
  40. data/node_modules/bulma/sass/elements/container.sass +2 -0
  41. data/node_modules/bulma/sass/elements/content.sass +4 -0
  42. data/node_modules/bulma/sass/elements/icon.sass +25 -0
  43. data/node_modules/bulma/sass/elements/image.sass +2 -0
  44. data/node_modules/bulma/sass/elements/notification.sass +2 -0
  45. data/node_modules/bulma/sass/elements/other.sass +2 -10
  46. data/node_modules/bulma/sass/elements/progress.sass +2 -0
  47. data/node_modules/bulma/sass/elements/table.sass +2 -0
  48. data/node_modules/bulma/sass/elements/tag.sass +2 -0
  49. data/node_modules/bulma/sass/elements/title.sass +2 -2
  50. data/node_modules/bulma/sass/form/_all.sass +6 -6
  51. data/node_modules/bulma/sass/form/file.sass +2 -0
  52. data/node_modules/bulma/sass/form/shared.sass +3 -0
  53. data/node_modules/bulma/sass/grid/_all.sass +2 -2
  54. data/node_modules/bulma/sass/grid/columns.sass +93 -84
  55. data/node_modules/bulma/sass/grid/tiles.sass +3 -1
  56. data/node_modules/bulma/sass/helpers/_all.sass +9 -9
  57. data/node_modules/bulma/sass/helpers/color.sass +2 -0
  58. data/node_modules/bulma/sass/helpers/float.sass +2 -0
  59. data/node_modules/bulma/sass/helpers/other.sass +3 -0
  60. data/node_modules/bulma/sass/helpers/position.sass +2 -0
  61. data/node_modules/bulma/sass/helpers/spacing.sass +1 -1
  62. data/node_modules/bulma/sass/helpers/typography.sass +5 -0
  63. data/node_modules/bulma/sass/helpers/visibility.sass +1 -1
  64. data/node_modules/bulma/sass/layout/_all.sass +3 -3
  65. data/node_modules/bulma/sass/layout/footer.sass +2 -0
  66. data/node_modules/bulma/sass/layout/hero.sass +8 -2
  67. data/node_modules/bulma/sass/layout/section.sass +6 -2
  68. data/node_modules/bulma/sass/utilities/_all.sass +6 -6
  69. data/node_modules/bulma/sass/utilities/animations.sass +1 -5
  70. data/node_modules/bulma/sass/utilities/controls.sass +2 -3
  71. data/node_modules/bulma/sass/utilities/derived-variables.sass +7 -0
  72. data/node_modules/bulma/sass/utilities/extends.sass +25 -0
  73. data/node_modules/bulma/sass/utilities/functions.sass +25 -4
  74. data/node_modules/bulma/sass/utilities/initial-variables.sass +5 -5
  75. data/node_modules/bulma/sass/utilities/mixins.sass +18 -23
  76. data/node_modules/bulma-block-list/.editorconfig +15 -0
  77. data/node_modules/bulma-block-list/.github/FUNDING.yml +12 -0
  78. data/node_modules/bulma-block-list/changelog.txt +17 -0
  79. data/node_modules/bulma-block-list/docs/Gemfile +2 -2
  80. data/node_modules/bulma-block-list/docs/_config.yml +2 -0
  81. data/node_modules/bulma-block-list/docs/_data/menu.yaml +3 -1
  82. data/node_modules/bulma-block-list/docs/_sass/_block-list.scss +30 -2
  83. data/node_modules/bulma-block-list/docs/index.html +96 -5
  84. data/node_modules/bulma-block-list/package.json +15 -42
  85. data/node_modules/bulma-block-list/src/block-list.scss +30 -2
  86. data/package-lock.json +36 -7
  87. data/package.json +1 -1
  88. metadata +14 -5
  89. data/_posts/2020-10-17-post-with-summary.md +0 -23
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5c6a0cc9b71f5dbbadbe42bfa8761dfe20140160bd0f17344d2e1918227ce003
4
- data.tar.gz: 2f72832cca44555c479437b4be5d37f922285d4b62e24991f00f3b045f50a038
3
+ metadata.gz: 411147a7d028879cd29523fb38f6df85bcaaa60dbd1f32f56720d9f8b51bf988
4
+ data.tar.gz: 59c0abdb9a67097f3e5e0d71a2ef264300ac958d90e65a44efbd4c752d0fb060
5
5
  SHA512:
6
- metadata.gz: da89ce6eb6854b055dfc78b96a1950bced3b6289aa2caa9d7fe85152d90abce0c8921c569ad9b01bd03ff2d9fc2aef944e09a375b128bf979223c9853cdf6b29
7
- data.tar.gz: 4fdaa04241cacfe2e0a939a2fe0dfc0b6e9e7ee157238dc1b37d5180cb85d39cc4af117695036502ff60239168f49fa79934ed830fb1f7996ed4ec3892e4d980
6
+ metadata.gz: 00f7bb88affdc05ec4244e3d00bfbaa0b513df006ac9103c24ac6ff05cf544511742407e399c8da0826ecef690e58e71bd4405c8df16ea9f2881260148ac61a8
7
+ data.tar.gz: 307d0c09cb5290057a5ca47f687a24a91372478c91b9e9dcc4761925aea6b43ee05a6e9aa041c8b2d4535f920903a1fa559c19aad653a0b4618b5f13bbe56476
data/README.md CHANGED
@@ -3,18 +3,21 @@
3
3
  [![Gem Version](https://badge.fury.io/rb/bulma-clean-theme.svg)](https://badge.fury.io/rb/bulma-clean-theme)
4
4
  ![Gem](https://img.shields.io/gem/dt/bulma-clean-theme.svg)
5
5
 
6
- This is a clean and simple Jekyll Theme built with the [Bulma](https://bulma.io/) framework, providing a modern looking site to start with.
6
+ This is a clean and simple Jekyll Theme built with the [Bulma](https://bulma.io/) framework, providing a modern-looking site to start with.
7
7
 
8
- The theme uses [Alpine.js](https://github.com/alpinejs/alpine) for it's interactive components, such as mobile navbar and notifications.
8
+ The theme uses [Alpine.js](https://github.com/alpinejs/alpine) for its interactive components, such as mobile navbar and notifications.
9
9
 
10
10
  ## Contents
11
11
 
12
12
  * [Installation](#installation)
13
13
  * [Usage](#usage)
14
+ * [Lang](#lang)
14
15
  * [Pages](#pages)
15
16
  * [Page Hero](#page-hero)
16
17
  * [Table Of Contents](#table-of-contents)
17
18
  * [Posts](#posts)
19
+ * [Post Excerpt and Summary](#post-excerpt-and-summary)
20
+ * [Series](#series)
18
21
  * [Navigation](#navigation)
19
22
  * [Colours and Styles](#colours-and-styles)
20
23
  * [Sidebar Visibility](#sidebar-visibility)
@@ -32,6 +35,7 @@ The theme uses [Alpine.js](https://github.com/alpinejs/alpine) for it's interact
32
35
  * [Sponsors](#sponsors)
33
36
  * [Gallery](#gallery)
34
37
  * [Disqus](#disqus)
38
+ * [Recipe](#recipe)
35
39
  * [Contributing](#contributing)
36
40
  * [Development](#development)
37
41
  * [Licence](#licence)
@@ -39,7 +43,7 @@ The theme uses [Alpine.js](https://github.com/alpinejs/alpine) for it's interact
39
43
 
40
44
  ## Installation
41
45
 
42
- **This theme requires Jekyll 3.8 so it is compatible with GitHub Pages.**
46
+ **This theme requires Jekyll 3.9 to be compatible with GitHub Pages.**
43
47
 
44
48
  Add this line to your Jekyll site's `Gemfile`:
45
49
 
@@ -63,52 +67,50 @@ Or install it yourself as:
63
67
 
64
68
  ## Usage
65
69
 
66
- ### Pages
70
+ ### Lang
67
71
 
68
- Create your pages as individual markdown files and use the `layout: page` for normal pages. Set the pages title and subtitle in the front matter and it will appear in the hero.
72
+ The html lang attribute is set to `en` by default but you can override this in the _config.yml file `lang: en`
73
+
74
+ ### Pages
75
+
76
+ Create your pages as individual Markdown files and use `layout: page` for normal pages. Set the page's title and subtitle in the front matter and it will appear in the hero.
69
77
 
70
78
  #### Page Hero
71
79
 
72
- **New in 0.2**
73
- Heros can now display a background image if you provide a `hero_image: /path/to/image.jpg` setting in your page front matter, or in the [defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/) in your sites `_config.yml`
80
+ **New in 0.2** - Heros can now display a background image if you provide a `hero_image: /path/to/image.jpg` setting in your page front matter, or in the [defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/) in your site's `_config.yml`.
74
81
 
75
- You can also set the height of the hero by providing a bulma hero height class in your front matter, such as `hero_height: is-fullwidth`. If you do not provide this, it will revert to is-medium
82
+ You can also set the height of the hero by providing a Bulma hero height class in your front matter, such as `hero_height: is-fullwidth`. If you do not provide this, it will revert to `is-medium`.
76
83
 
77
- **New in 0.5.4**
78
- If you would like to add a call to action button in the hero then add `hero_link` and `hero_link_text` to the page's front matter.
84
+ **New in 0.5.4** - If you would like to add a call to action button in the hero then add `hero_link` and `hero_link_text` to the page's front matter.
79
85
 
80
- **New in 0.5.7**
81
- If you would like to hide the hero, you can set `hide_hero: true` in the page's front matter.
86
+ **New in 0.5.7** - If you would like to hide the hero, you can set `hide_hero: true` in the page's front matter.
82
87
 
83
- **New in 0.7.1**
84
- If you would like to darken the hero so the title stands out more, you can set `hero_darken: true` in the page's front matter. You can overwrite the default background colour by setting the `$hero-darken` sass variable.
88
+ **New in 0.7.1** - If you would like to darken the hero so the title stands out more, you can set `hero_darken: true` in the page's front matter. You can overwrite the default background colour by setting the `$hero-darken` sass variable.
85
89
 
86
90
  #### Table Of Contents
87
91
 
88
- **New in 0.5.8**
89
- If you want to display a table of contents (toc) then add `toc: true` to your page's front matter. You can customise the default table of contents title by setting `toc_title: My Custom Title` in the page's front matter.
92
+ **New in 0.5.8** - If you want to display a table of contents (toc) then add `toc: true` to your page's front matter. You can customise the default table of contents title by setting `toc_title: My Custom Title` in the page's front matter.
90
93
 
91
- **New in 0.10.3**
92
- If you would prefer to display the contents in the menubar at the side of the page, then use `menubar_toc: true` instead of `toc: true`. This will also override the page's `menubar` setting.
94
+ **New in 0.10.3** - If you would prefer to display the contents in the menubar at the side of the page, then use `menubar_toc: true` instead of `toc: true`. This will also override the page's `menubar` setting.
93
95
 
94
96
  ### Posts
95
97
 
96
- If you want posts, create a `_posts` directory to store your posts as per normal Jekyll usage, with the `layout: post`. Next create a `blog` directory with an index.html file that has `layout: blog`
98
+ If you want posts, create a `_posts` directory to store your posts as per normal Jekyll usage, with `layout: post`. Next, create a `blog` directory with an index.html file that has `layout: blog`.
97
99
 
98
- Set the paginate and the paginate_path up in the `_config.yaml` to configure the posts per page and the blog pagination path.
100
+ Set `paginate` and `paginate_path` in your site's `_config.yaml` to configure the posts per page and blog pagination path.
99
101
 
100
102
  ```yaml
101
103
  paginate: 5
102
104
  paginate_path: "/blog/page:num"
103
105
  ```
104
106
 
105
- **New in 0.2** It will now display an image in the blog page if you set `image: /path/to/image.jpg` in your post's or page's front matter, or in the [defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/) in your sites `_config.yml`
107
+ **New in 0.2** - It will now display an image in the blog page if you set `image: /path/to/image.jpg` in your post's or page's front matter, or in the [defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/) in your site's `_config.yml`.
106
108
 
107
- You can also set the height of the hero by providing a Bulma hero height class in your front matter, such as `hero_height: is-fullwidth`. If you do not provide this, it will revert to is-medium
109
+ You can also set the height of the hero by providing a Bulma hero height class in your front matter, such as `hero_height: is-fullwidth`. If you do not provide this, it will revert to `is-medium`.
108
110
 
109
111
  #### Post Excerpt and Summary
110
112
 
111
- By default the blog page and the latest posts will use the automatically generated post excerpt. If you would like to override this you can set the summary in the post's front matter.
113
+ By default, the blog page and the latest posts will use the automatically generated post excerpt. If you would like to override this you can set the summary in the post's front matter.
112
114
 
113
115
  ```yaml
114
116
  layout: post
@@ -116,7 +118,56 @@ title: The post title
116
118
  summary: |-
117
119
  This is the custom summary for the post.
118
120
 
119
- It can be in **markdown format** if required.
121
+ It can be in **Markdown format** if required.
122
+ ```
123
+
124
+ #### Series
125
+
126
+ From version 0.12, you can now make a post a part of a series of posts, linking to the other posts in the series, by creating a `series` data file and then setting the series in each of the post's front matter.
127
+
128
+ The current post in the list is highlighted to help give context of where you are in the series.
129
+
130
+ ##### Blog Series Data File
131
+
132
+ Start by creating a yml file in the _data directory, for example `my_blog_series.yml`. Give the series a title and, optionally, a description.
133
+
134
+ ##### Sections
135
+
136
+ Next add sections. Each section can have a label (optional) and items. Each item is the title of an existing blog post. If the title is not found then the link will be empty.
137
+
138
+ If you just want one list without labels, then omit the label and just add the items.
139
+
140
+ ```yaml
141
+ title: The series title
142
+ sections:
143
+ - items:
144
+ - title: Why use a static site generator
145
+ - title: Getting started with Bulma Clean Theme for Jekyll
146
+ ```
147
+
148
+ Here is a full example with multiple sections with labels.
149
+
150
+ ```yaml
151
+ title: The series title
152
+ description: The series description text
153
+ sections:
154
+ - label: The first section
155
+ items:
156
+ - title: Why use a static site generator
157
+ - title: Getting started with Bulma Clean Theme for Jekyll
158
+ - label: Another section
159
+ items:
160
+ - title: Introducing some new layouts to Bulma Clean Theme
161
+ - title: Creating a docs site with Bulma Clean Theme
162
+ - title: Creating a post series
163
+ ```
164
+
165
+ ##### Update your posts
166
+
167
+ Finally, add the series setting to your front matter in each post you want the series to show in.
168
+
169
+ ```yaml
170
+ series: my_blog_series
120
171
  ```
121
172
 
122
173
  #### Social Share Buttons
@@ -126,7 +177,7 @@ Share buttons will be displayed on your posts unless you hide them by adding `hi
126
177
 
127
178
  ### Navigation
128
179
 
129
- For the top navigation, create a navigation.yml file in `_data` directory with the following format with the pages you want to include in the top navigation. You can now also add items to a dropdown menu.
180
+ For the top navigation, create a navigation.yml file in the `_data` directory with the following format with the pages you want to include in the top navigation. You can now also add items to a dropdown menu.
130
181
 
131
182
  ```yaml
132
183
  - name: Page 1
@@ -138,16 +189,16 @@ For the top navigation, create a navigation.yml file in `_data` directory with t
138
189
  link: /page-2/
139
190
  ```
140
191
 
141
- For the current page to have an active class, ensure the `link:` format matches your [permalink](https://jekyllrb.com/docs/permalinks/#extensionless-permalinks) format. The above example will work with `permalink: pretty` setting in your `_config.yml`
192
+ For the current page to have an active class, ensure the `link:` format matches your [permalink](https://jekyllrb.com/docs/permalinks/#extensionless-permalinks) format. The above example will work with a `permalink: pretty` setting in your `_config.yml`.
142
193
 
143
194
  #### Fixed Navbar
144
195
 
145
- To have a fixed navbar, you can set `fixed_navbar: top` or `fixed_navbar: bottom` respectively in your
196
+ To have a fixed navbar on the top or bottom of your site, you can set `fixed_navbar: top` or `fixed_navbar: bottom` respectively in your
146
197
  `_config.yml`.
147
198
 
148
199
  ### Colours and Styles
149
200
 
150
- To overwrite the primary theme colour, set a sass variable in `assets/css/app.scss` before importing `main`
201
+ To overwrite the primary theme colour, set a sass variable in `assets/css/app.scss` before importing `main`.
151
202
 
152
203
  ```
153
204
  ---
@@ -157,7 +208,7 @@ $primary: #333333;
157
208
  @import "main";
158
209
  ```
159
210
 
160
- You can overwrite any of the [Bulma initial variables](http://versions.bulma.io/0.7.0/documentation/overview/variables/) in this way as long as they are declared before the `@import "main"'`
211
+ You can overwrite any of the [Bulma initial variables](http://versions.bulma.io/0.7.0/documentation/overview/variables/) in this way as long as they are declared before the `@import "main";`.
161
212
 
162
213
  #### Theme Color Meta Tag
163
214
 
@@ -165,26 +216,22 @@ If you want to update the theme color meta tag then set `theme_color: '#333333'`
165
216
 
166
217
  ### Sidebar Visibility
167
218
 
168
- **New in 0.2**
169
-
170
- If you want to show the sidebar with latest posts then set `show_sidebar: true` in the pages frontmatter, or in the [defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/) in your sites `_config.yml`
219
+ **New in 0.2** - If you want to show the sidebar with latest posts then set `show_sidebar: true` in the page's frontmatter, or in the [defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/) in your site's `_config.yml`.
171
220
 
172
221
  ### Menubar
173
222
 
174
- **New in 0.3**
175
-
176
- The menubar gets its content from a data file in your site's `_data` directory. Simply set the name of your data file in the page's menubar setting in the frontmatter.
223
+ **New in 0.3** - The menubar gets its content from a data file in your site's `_data` directory. Simply set the name of your data file in the page's menubar setting in the frontmatter.
177
224
 
178
225
  ```yaml
179
226
  show_sidebar: false
180
227
  menubar: example_menu
181
228
  ```
182
229
 
183
- You will probably want to disable the show_sidebar otherwise there will be little room for the page content.
230
+ You will probably want to disable `show_sidebar`. Otherwise there will be little room for the page content.
184
231
 
185
232
  #### Creating a menubar data file
186
233
 
187
- Create a data file in the _data directory and use the following format (if using yml)
234
+ Create a data file in the `_data` directory and use the following format (if using yml).
188
235
 
189
236
  ```yaml
190
237
  - label: Example Menu
@@ -204,11 +251,11 @@ Create a data file in the _data directory and use the following format (if using
204
251
  link: /blog/
205
252
  ```
206
253
 
207
- For the current page to have an active class, ensure the `link:` format matches your [permalink](https://jekyllrb.com/docs/permalinks/#extensionless-permalinks) format. The above example will work with `permalink: pretty` setting in your `_config.yml`
254
+ For the current page to have an active class, ensure the `link:` format matches your [permalink](https://jekyllrb.com/docs/permalinks/#extensionless-permalinks) format. The above example will work with `permalink: pretty` setting in your `_config.yml`.
208
255
 
209
256
  #### Multiple menus
210
257
 
211
- You may make multiple menus in the same file, separated by the label
258
+ You may make multiple menus in the same file, separated by labels.
212
259
 
213
260
  ```yaml
214
261
  - label: Menu Label
@@ -232,9 +279,7 @@ You may make multiple menus in the same file, separated by the label
232
279
 
233
280
  ### Tabs
234
281
 
235
- **New in 0.4**
236
-
237
- The tabs gets its content from a data file in your site's `_data` directory. Simply set the name of your data file in the page's menubar setting in the front matter.
282
+ **New in 0.4** - `tabs` gets its content from a data file in your site's `_data` directory. Simply set the name of your data file in the page's menubar setting in the front matter.
238
283
 
239
284
  ```yaml
240
285
  title: Page with tabs
@@ -249,7 +294,7 @@ Tabs can be used in conjunction with menubar and/or sidebar if you wish.
249
294
 
250
295
  #### Creating a tabs data file
251
296
 
252
- Create a data file in the _data directory and use the following format (if using yml)
297
+ Create a data file in the `_data` directory and use the following format (if using yml).
253
298
 
254
299
  ```yaml
255
300
  alignment: is-left
@@ -272,7 +317,7 @@ items:
272
317
 
273
318
  #### Settings
274
319
 
275
- You can control the alignment, style and size of the tabs by using the relevant [Bulma tabs classes](https://bulma.io/documentation/components/tabs/).
320
+ You can control the alignment, style, and size of tabs by using the relevant [Bulma tabs classes](https://bulma.io/documentation/components/tabs/).
276
321
 
277
322
  #### Active Tab Highlighting
278
323
 
@@ -280,9 +325,7 @@ It will automatically mark the active tab based on the current page.
280
325
 
281
326
  #### Icons
282
327
 
283
- You can add icons to your tab by passing in the [Font Awesome icon class](https://fontawesome.com/icons?d=gallery).
284
-
285
- If you don't wish to show icons then simply omit the option from your yaml file.
328
+ You can add icons to your tab by passing in the [Font Awesome icon class](https://fontawesome.com/icons?d=gallery). If you don't wish to show icons then simply omit the option from your yaml file.
286
329
 
287
330
  ### Notifications
288
331
 
@@ -328,15 +371,11 @@ You can overwrite the default style (is-primary) by passing in the style in the
328
371
 
329
372
  ### Google Analytics
330
373
 
331
- **New in 0.2**
332
-
333
- To enable Google Analytics add `google_analytics: UA-xxxxxxxx` to your `_config.yml` replacing the UA-xxxxxxxx with your Google Analytics property
374
+ **New in 0.2** - To enable Google Analytics add `google_analytics: UA-xxxxxxxx` to your `_config.yml` replacing the UA-xxxxxxxx with your Google Analytics property.
334
375
 
335
376
  ### Footer
336
377
 
337
- **New in 0.4.1**
338
-
339
- To add some footer links, create a yaml file in the `_data` directory using the following format
378
+ **New in 0.4.1** - To add some footer links, create a yaml file in the `_data` directory using the following format.
340
379
 
341
380
  ```yaml
342
381
  - name: Blog
@@ -347,7 +386,7 @@ To add some footer links, create a yaml file in the `_data` directory using the
347
386
  link: /privacy-policy/
348
387
  ```
349
388
 
350
- Then add the name of your yaml file (without the .yml extension) into the footer_menu setting in the `_config.yml`
389
+ Then add the name of your yaml file (without the .yml extension) into the `footer_menu` setting in the `_config.yml`.
351
390
 
352
391
  ```yaml
353
392
  footer_menu: example_footer_menu
@@ -355,19 +394,15 @@ footer_menu: example_footer_menu
355
394
 
356
395
  #### Hiding the footer
357
396
 
358
- **New in 0.5.2**
359
-
360
- If you would like to hide the footer on a particular page then set `hide_footer: true` in the page's frontmatter.
397
+ **New in 0.5.2** - If you would like to hide the footer on a particular page then set `hide_footer: true` in the page's frontmatter.
361
398
 
362
399
  ### Products
363
400
 
364
- **New in 0.5**
365
-
366
- Now you can add simple product pages to your site using collections.
401
+ **New in 0.5** - Now you can add simple product pages to your site using collections.
367
402
 
368
403
  #### Product pages
369
404
 
370
- Start by creating a `_products` directory to hold your product pages and create a new page for each product, such as `product1.md`. In the front matter for this page you can set the standard settings, such as your title, subtitle, description (for meta-description), hero_image, as well as the additional product settings such as price, product_code, image, features and rating.
405
+ Start by creating a `_products` directory to hold your product pages and create a new page for each product, such as `product1.md`. In the front matter for this page you can set the standard settings, such as your title, subtitle, description (for meta-description), hero_image, as well as the additional product settings such as price, product_code, image, features, and rating.
371
406
 
372
407
  ```yaml
373
408
  title: Product 1 Name
@@ -405,7 +440,7 @@ You can also set default product page values here if you like, such as the layou
405
440
 
406
441
  #### Product Reviews
407
442
 
408
- To add reviews to your product page, create a `reviews` directory in the `_data` directory and add a yml file with the name of the product_code from the product page, for example `_data/reviews/ABC124.yml`. Create the reviews using the following format:
443
+ To add reviews to your product page, create a `reviews` directory in the `_data` directory and add a yaml file with the name of the product_code from the product page, for example `_data/reviews/ABC124.yml`. Create the reviews using the following format:
409
444
 
410
445
  ```yaml
411
446
  - name: Mr E Xample
@@ -424,7 +459,7 @@ To add reviews to your product page, create a `reviews` directory in the `_data`
424
459
  The product worked exactly as described.
425
460
  ```
426
461
 
427
- If you don't want to display an avatar image then a default user icon will be displayed. If you don't want to display a rating then omit it from the yml.
462
+ If you don't want to display an avatar image then a default user icon will be displayed. If you don't want to display a rating then omit it from the yaml file.
428
463
 
429
464
  #### Product Category Page
430
465
 
@@ -440,23 +475,21 @@ sort: title
440
475
 
441
476
  ### Scripts
442
477
 
443
- **New in 0.5.2**
444
-
445
- There are two new files within the includes directory called `head-scripts.html` and `footer-scripts.html`. These are empty files by default but allow you to add any additional JavaScript to your site, such as the script for AddThis share buttons, in the `<head>` or after the `<footer>` of the page.
478
+ **New in 0.5.2** - There are two new files within the includes directory called `head-scripts.html` and `footer-scripts.html`. These are empty files by default but allow you to add any additional JavaScript to your site, such as the script for AddThis share buttons, in the `<head>` or after the `<footer>` of the page.
446
479
 
447
480
  ### Callouts
448
481
 
449
- **New in 0.5.4**
482
+ **New in 0.5.4** - You can now add callouts to a page to make a landing page style layout.
450
483
 
451
- You can now add callouts to a page to make a landing page style layout.
484
+ * [Example of page with callouts - notice the 'calls to action' below the header.](http://www.csrhymes.com/bulma-clean-theme/landing/)
452
485
 
453
486
  #### Create a callout data file
454
487
 
455
488
  Create a data file following the below format. The style is for classes to set the background colour and sizes you would like to use of the Bulma hero container for the callouts.
456
489
 
457
- **New in 0.5.7** You can set the height of the callouts in the data file, such as is-small, is-medium or is-large. If unset it will be is-medium by default.
490
+ **New in 0.5.7** - You can set the height of the callouts in the data file, such as `is-small`, `is-medium`, or `is-large`. If unset it will be `is-medium` by default.
458
491
 
459
- The items have 6 fields, but only the title and subtitle are required. If the icon is a brand icon, such as GitHub in the below example, set `icon_brand: true`.
492
+ The items have six fields, but only the title and subtitle are required. If the icon is a brand icon, such as GitHub in the below example, set `icon_brand: true`.
460
493
 
461
494
  ```yaml
462
495
  style: is-light
@@ -476,7 +509,7 @@ items:
476
509
 
477
510
  #### Set the callouts in the frontmatter
478
511
 
479
- To display the callouts on your page, add a callouts property in the frontmatter and set it to the name of your data file without the extension.
512
+ To display the callouts on your page, add a `callouts` property in the frontmatter and set it to the name of your data file without the extension.
480
513
 
481
514
  ```yaml
482
515
  layout: page
@@ -487,7 +520,7 @@ callouts: example_callouts
487
520
 
488
521
  ### Favicon
489
522
 
490
- The default favicon path is `{{ site.baseurl }}/favicon.png` but you can overwrite it in the sites `_config.yml` like this `favicon: /path/to/favicon.png`
523
+ The default favicon path is `{{ site.baseurl }}/favicon.png` but you can overwrite it in the site's `_config.yml` like this `favicon: /path/to/favicon.png`
491
524
 
492
525
  ### Showcases
493
526
 
@@ -495,13 +528,13 @@ Showcases allow you to display your work to others using a simple layout.
495
528
 
496
529
  #### Creating A Showcase Datafile
497
530
 
498
- Create a datafile in your sites `_data` directory in the following format. Subtitle, features and tags are not required.
531
+ Create a datafile in your site's `_data` directory in the following format. Subtitle, features and tags are not required.
499
532
 
500
- The description text accepts markdown and is run through the markdownify filter on the page.
533
+ The description text accepts Markdown and is run through the markdownify filter on the page.
501
534
 
502
- The image_ratio will default to is-16by9 if it is not defined and accepts the [Bulma image](https://bulma.io/documentation/elements/image/) classes.
535
+ The `image_ratio` will default to `is-16by9` if it is not defined and accepts the [Bulma image](https://bulma.io/documentation/elements/image/) classes.
503
536
 
504
- To display GitHub Stars, Forks and Watchers badges add your GitHub user and repo name to the github setting, such as `chrisrhymes/bulma-clean-theme`
537
+ To display GitHub Stars, Forks, and Watchers badges, add your GitHub user and repo name to the `github` setting, such as `chrisrhymes/bulma-clean-theme`.
505
538
 
506
539
  To change the default styles of the features, set `features_styles`. This uses the styles from [bulma-block-list](https://www.csrhymes.com/bulma-block-list/) npm package.
507
540
 
@@ -510,7 +543,7 @@ intro: |-
510
543
  This is some introduction text for the showcases.
511
544
 
512
545
  ## Example Heading
513
- It can convert markdown format
546
+ It can convert Markdown format
514
547
 
515
548
  items:
516
549
  - title: Example showcase item
@@ -602,7 +635,7 @@ Start by creating a gallery data file using the below format, for example `my_ga
602
635
  large_link: https://via.placeholder.com/1200x675
603
636
  alt: The alt text for the image
604
637
  description: |-
605
- The image description can be written in **markdown** if required
638
+ The image description can be written in **Markdown** if required
606
639
  ratio: is-16by9
607
640
  - link: https://via.placeholder.com/800x600
608
641
  large_link: https://via.placeholder.com/1200x675
@@ -612,13 +645,13 @@ Start by creating a gallery data file using the below format, for example `my_ga
612
645
  ```
613
646
 
614
647
  * If a ratio is not provided it will default to 16 by 9. Use [Bulma image](https://bulma.io/documentation/elements/image/) classes to define the image ratio required.
615
- * The description can be plain text or it can be markdown if required.
616
- * The alt will be used as the images alt text.
617
- * The large_link displays in a modal when the image is clicked
648
+ * The description can be plaintext or it can be Markdown if required.
649
+ * The alt will be used as the image's alt text.
650
+ * The large_link displays in a modal when the image is clicked.
618
651
 
619
652
  #### Displaying the gallery
620
653
 
621
- In your pages front matter add a gallery with the datafiles filename without the extension.
654
+ In your page's front matter add a gallery with the datafile's filename without the extension.
622
655
 
623
656
  ```yaml
624
657
  layout: page
@@ -628,7 +661,14 @@ gallery: my_gallery
628
661
 
629
662
  ### Disqus
630
663
 
631
- Disqus comments are available for posts. To be able to use them, you need to set your disqus shortname in `_config.yml`. Then you need to set your Jekyll environment to production:
664
+ Disqus comments are available for posts. To be able to use them, you need to set your disqus shortname in `_config.yml`.
665
+ ```
666
+ disqus.shortname=<example-com.disqus.com>
667
+ ```
668
+
669
+ Need help finding your Disqus Shortname? [See this helpful post by Disqus on the matter.](https://help.disqus.com/en/articles/1717111-what-s-a-shortname)
670
+
671
+ Then you need to set your Jekyll environment to production:
632
672
 
633
673
  ```JEKYLL_ENV=production bundle exec jekyll build```.
634
674
 
@@ -638,7 +678,53 @@ Comments are enabled by default. If you want to disable them, set in the front m
638
678
  comments: false
639
679
  ```
640
680
 
681
+ ### Recipe
682
+
683
+ You can make a single page using the recipe layout, or you can use it in your blog by specifying the `layout: recipe` instead of post.
684
+
685
+ You probably want to hide the sidebar, so the recipe takes up the whole page width. If you add any additional content to the page it will appear below the recipe details.
641
686
 
687
+ Create a list in the front matter for the ingredients, then the method steps and it will automatically be added to the page.
688
+
689
+ The front matter will also be added to the page as schema data that is used by search engines. Please see the below example for all of the schema options available.
690
+
691
+ ```yaml
692
+ layout: recipe
693
+ title: An Example Recipe Page
694
+ subtitle: Tastes great and easy to cook
695
+ author: CS Rhymes
696
+ date: 2021-03-02
697
+ show_sidebar: false
698
+ image: /bulma-clan-theme/img/recipe-example.jpg
699
+ hero_image: /bulma-clean-theme/img/recipe-example.jpg
700
+ ingredients:
701
+ - 1tsp vegetable oil
702
+ - 2 Carrots, finely diced
703
+ - 1 Onion, finely dices
704
+ - 1 Celery stick, finely diced
705
+ - 2 Cloves of Garlic, crushed
706
+ - 400g lean Minced Beef
707
+ - 400g tin of Chopped Tomatoes
708
+ - 2tbsp Tomato Puree
709
+ - 300ml Beef Stock
710
+ - 1tsp Worcestershire Sauce
711
+ - 2tsp Italian Herbs
712
+ - Salt and Pepper
713
+ method:
714
+ - Heat the vegetable oil in a large pan on a medium heat, then add the carrots, onion and celery and cook for five to ten minutes to soften, stirring occasionally
715
+ - Add the crushed garlic and cook for 2 more minutes, stiffing occasionally
716
+ - Add the minced beef to the pan, breaking it up with a wooden spoon and cook until browned off
717
+ - Add the chopped tomatoes, tomato puree, beef stock, worcestershire sauce and italian herbs and stir. Add a pinch of salt and pepper then stir through
718
+ - Bring to a gentle simmer and cook for 30 minutes
719
+ prep_time: PT0H10M
720
+ cook_time: PT1H
721
+ total_time: PT1H10M
722
+ keywords: recipe,cooking
723
+ recipe_yield: 4
724
+ recipe_category: Main course
725
+ recipe_cuisine: Italian
726
+ calories: 500 calories
727
+ ```
642
728
 
643
729
  ## Contributing
644
730
 
@@ -648,7 +734,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/chrisr
648
734
 
649
735
  To set up your environment to develop this theme, run `bundle install`.
650
736
 
651
- Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
737
+ Your theme is set up just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
652
738
 
653
739
  ## License
654
740
 
@@ -0,0 +1,32 @@
1
+ {% assign series = site.data.[page.series] %}
2
+ {% assign posts = site.posts %}
3
+
4
+ <p class="title is-5 is-spaced">{{ series.title }}</p>
5
+
6
+ {% if series.description %}
7
+ <p>{{ series.description }}</p>
8
+ {% endif %}
9
+
10
+ {% for section in series.sections %}
11
+
12
+ {% if section.label %}
13
+ <p class="title is-6">{{ section.label }}</p>
14
+ {% endif %}
15
+
16
+ <ul class="block-list is-small is-outlined">
17
+ {% for item in section.items %}
18
+ {% assign post = posts | where: "title", item.title %}
19
+
20
+ {% if page.url == post[0].url %}
21
+ <li class="is-highlighted is-dark">
22
+ <p>{{ item.title }}</p>
23
+ </li>
24
+ {% else %}
25
+ <li>
26
+ <a href="{{ site.baseurl }}{{ post[0].url }}" class="is-flex" >{{ item.title }}</a>
27
+ </li>
28
+ {% endif %}
29
+
30
+ {% endfor %}
31
+ </ul>
32
+ {% endfor %}
@@ -0,0 +1,3 @@
1
+ <figure class="image is-16by9">
2
+ <iframe src="https://player.vimeo.com/video/{{ include.video }}?color=ff9933&title=0&byline=0&portrait=0" class="has-ratio" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen></iframe><script src="https://player.vimeo.com/api/player.js"></script>
3
+ </figure>
@@ -1,6 +1,6 @@
1
1
  <figure class="image is-16by9">
2
2
  <iframe class="has-ratio"
3
- src="https://www.youtube.com/embed/{{ include.video }}?showinfo=0"
3
+ src="https://www.youtube.com/embed/{{ include.video }}?start={{ include.time | default: 0 }}&showinfo=0"
4
4
  frameborder="0"
5
5
  allowfullscreen
6
6
  >
@@ -1,17 +1,19 @@
1
+ <!DOCTYPE html>
1
2
  {% if page.menubar or page.menubar_toc %}
2
- {% assign has_left_sidebar = true %}
3
+ {% assign has_left_sidebar = true %}
3
4
  {% endif %}
4
5
 
5
- {% if page.show_sidebar and has_left_sidebar %}
6
- {% assign content_width = 'is-4' %}
7
- {% elsif page.show_sidebar or has_left_sidebar %}
8
- {% assign content_width = 'is-8' %}
9
- {% else %}
10
- {% assign content_width = 'is-12' %}
6
+ {% if page.show_sidebar and has_left_sidebar %}
7
+ {% assign content_width = 'is-4' %}
8
+ {% elsif page.show_sidebar or has_left_sidebar %}
9
+ {% assign content_width = 'is-8' %}
10
+ {% else %}
11
+ {% assign content_width = 'is-12' %}
11
12
  {% endif %}
12
13
 
13
- <!DOCTYPE html>
14
- <html {% if site.fixed_navbar %} class="has-navbar-fixed-{{ site.fixed_navbar }}" {% endif %}>
14
+ <html
15
+ lang="{{ site.lang | default: 'en' }}"
16
+ {% if site.fixed_navbar %}class="has-navbar-fixed-{{ site.fixed_navbar }}"{% endif %}>
15
17
  {% include head.html %}
16
18
  <body>
17
19
  {% include header.html %}
@@ -21,7 +23,7 @@
21
23
  {% include callouts.html %}
22
24
  <section class="section">
23
25
  <div class="container">
24
- <div class="columns">
26
+ <div class="columns is-multiline">
25
27
  {% if page.menubar_toc %}
26
28
  <div class="column is-4-desktop is-4-tablet">
27
29
  {% assign contentsTitle = page.toc_title | default: 'Contents' %}
@@ -40,7 +42,7 @@
40
42
  {{ content }}
41
43
  </div>
42
44
  {% if site.posts and page.show_sidebar %}
43
- <div class="column is-4-desktop is-12-tablet">
45
+ <div class="column is-4-desktop is-4-tablet">
44
46
  {% include latest-posts.html %}
45
47
  </div>
46
48
  {% endif %}
@@ -54,4 +56,3 @@
54
56
  {%- include footer-scripts.html -%}
55
57
  </body>
56
58
  </html>
57
-
data/_layouts/post.html CHANGED
@@ -6,6 +6,10 @@ layout: default
6
6
 
7
7
  <p>Published: {{ page.date | date: "%b %-d, %Y" }} by {{ page.author }}</p>
8
8
 
9
+ {% if page.series %}
10
+ {% include series.html %}
11
+ {% endif %}
12
+
9
13
  {{ content }}
10
14
  </div>
11
15