bulma-clean-theme 0.10.6 → 0.11
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +118 -85
- data/_includes/vimeo.html +3 -0
- data/_includes/youtube.html +1 -1
- data/_layouts/default.html +11 -10
- data/_layouts/recipe.html +76 -0
- metadata +4 -3
- 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:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5052844214109f6cf84c0941968992b3fa9fccdbb53aec24f9bda71bf449815e
|
|
4
|
+
data.tar.gz: bbae03beff51176c16f82d187b245279f10261a1bde06e38ca4871fdb0a3d2bc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2a54dfdd5199216700c56fdaddbeda5b129766c0972aac0943ea85130c1ce1a8689144ed7042aae9ef1927d7cb1e168cc40b119d8eb61ffa3f44ccf6e02efa9b
|
|
7
|
+
data.tar.gz: f9a7655efe475afd853ae1c49509eda61c375f53255e576f287f94f32ac788475ca8cf22aaf60a1d0affec254ebe67ecdf5c616e6a8cca9a6f62beb025a40aab
|
data/README.md
CHANGED
|
@@ -3,14 +3,15 @@
|
|
|
3
3
|
[](https://badge.fury.io/rb/bulma-clean-theme)
|
|
4
4
|
|
|
5
5
|
|
|
6
|
-
This is a clean and simple Jekyll Theme built with the [Bulma](https://bulma.io/) framework, providing a modern
|
|
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
|
|
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)
|
|
@@ -32,6 +33,7 @@ The theme uses [Alpine.js](https://github.com/alpinejs/alpine) for it's interact
|
|
|
32
33
|
* [Sponsors](#sponsors)
|
|
33
34
|
* [Gallery](#gallery)
|
|
34
35
|
* [Disqus](#disqus)
|
|
36
|
+
* [Recipe](#recipe)
|
|
35
37
|
* [Contributing](#contributing)
|
|
36
38
|
* [Development](#development)
|
|
37
39
|
* [Licence](#licence)
|
|
@@ -39,7 +41,7 @@ The theme uses [Alpine.js](https://github.com/alpinejs/alpine) for it's interact
|
|
|
39
41
|
|
|
40
42
|
## Installation
|
|
41
43
|
|
|
42
|
-
**This theme requires Jekyll 3.
|
|
44
|
+
**This theme requires Jekyll 3.9 to be compatible with GitHub Pages.**
|
|
43
45
|
|
|
44
46
|
Add this line to your Jekyll site's `Gemfile`:
|
|
45
47
|
|
|
@@ -63,52 +65,50 @@ Or install it yourself as:
|
|
|
63
65
|
|
|
64
66
|
## Usage
|
|
65
67
|
|
|
66
|
-
###
|
|
68
|
+
### Lang
|
|
67
69
|
|
|
68
|
-
|
|
70
|
+
The html lang attribute is set to `en` by default but you can override this in the _config.yml file `lang: en`
|
|
71
|
+
|
|
72
|
+
### Pages
|
|
73
|
+
|
|
74
|
+
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
75
|
|
|
70
76
|
#### Page Hero
|
|
71
77
|
|
|
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`
|
|
78
|
+
**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
79
|
|
|
75
|
-
You can also set the height of the hero by providing a
|
|
80
|
+
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
81
|
|
|
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.
|
|
82
|
+
**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
83
|
|
|
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.
|
|
84
|
+
**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
85
|
|
|
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.
|
|
86
|
+
**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
87
|
|
|
86
88
|
#### Table Of Contents
|
|
87
89
|
|
|
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.
|
|
90
|
+
**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
91
|
|
|
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.
|
|
92
|
+
**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
93
|
|
|
94
94
|
### Posts
|
|
95
95
|
|
|
96
|
-
If you want posts, create a `_posts` directory to store your posts as per normal Jekyll usage, with
|
|
96
|
+
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
97
|
|
|
98
|
-
Set
|
|
98
|
+
Set `paginate` and `paginate_path` in your site's `_config.yaml` to configure the posts per page and blog pagination path.
|
|
99
99
|
|
|
100
100
|
```yaml
|
|
101
101
|
paginate: 5
|
|
102
102
|
paginate_path: "/blog/page:num"
|
|
103
103
|
```
|
|
104
104
|
|
|
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
|
|
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 site's `_config.yml`.
|
|
106
106
|
|
|
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
|
|
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`.
|
|
108
108
|
|
|
109
109
|
#### Post Excerpt and Summary
|
|
110
110
|
|
|
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.
|
|
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.
|
|
112
112
|
|
|
113
113
|
```yaml
|
|
114
114
|
layout: post
|
|
@@ -116,7 +116,7 @@ title: The post title
|
|
|
116
116
|
summary: |-
|
|
117
117
|
This is the custom summary for the post.
|
|
118
118
|
|
|
119
|
-
It can be in **
|
|
119
|
+
It can be in **Markdown format** if required.
|
|
120
120
|
```
|
|
121
121
|
|
|
122
122
|
#### Social Share Buttons
|
|
@@ -126,7 +126,7 @@ Share buttons will be displayed on your posts unless you hide them by adding `hi
|
|
|
126
126
|
|
|
127
127
|
### Navigation
|
|
128
128
|
|
|
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.
|
|
129
|
+
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
130
|
|
|
131
131
|
```yaml
|
|
132
132
|
- name: Page 1
|
|
@@ -138,16 +138,16 @@ For the top navigation, create a navigation.yml file in `_data` directory with t
|
|
|
138
138
|
link: /page-2/
|
|
139
139
|
```
|
|
140
140
|
|
|
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
|
|
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 a `permalink: pretty` setting in your `_config.yml`.
|
|
142
142
|
|
|
143
143
|
#### Fixed Navbar
|
|
144
144
|
|
|
145
|
-
To have a fixed navbar, you can set `fixed_navbar: top` or `fixed_navbar: bottom` respectively in your
|
|
145
|
+
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
146
|
`_config.yml`.
|
|
147
147
|
|
|
148
148
|
### Colours and Styles
|
|
149
149
|
|
|
150
|
-
To overwrite the primary theme colour, set a sass variable in `assets/css/app.scss` before importing `main
|
|
150
|
+
To overwrite the primary theme colour, set a sass variable in `assets/css/app.scss` before importing `main`.
|
|
151
151
|
|
|
152
152
|
```
|
|
153
153
|
---
|
|
@@ -157,7 +157,7 @@ $primary: #333333;
|
|
|
157
157
|
@import "main";
|
|
158
158
|
```
|
|
159
159
|
|
|
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"
|
|
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";`.
|
|
161
161
|
|
|
162
162
|
#### Theme Color Meta Tag
|
|
163
163
|
|
|
@@ -165,26 +165,22 @@ If you want to update the theme color meta tag then set `theme_color: '#333333'`
|
|
|
165
165
|
|
|
166
166
|
### Sidebar Visibility
|
|
167
167
|
|
|
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`
|
|
168
|
+
**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
169
|
|
|
172
170
|
### Menubar
|
|
173
171
|
|
|
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.
|
|
172
|
+
**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
173
|
|
|
178
174
|
```yaml
|
|
179
175
|
show_sidebar: false
|
|
180
176
|
menubar: example_menu
|
|
181
177
|
```
|
|
182
178
|
|
|
183
|
-
You will probably want to disable
|
|
179
|
+
You will probably want to disable `show_sidebar`. Otherwise there will be little room for the page content.
|
|
184
180
|
|
|
185
181
|
#### Creating a menubar data file
|
|
186
182
|
|
|
187
|
-
Create a data file in the _data directory and use the following format (if using yml)
|
|
183
|
+
Create a data file in the `_data` directory and use the following format (if using yml).
|
|
188
184
|
|
|
189
185
|
```yaml
|
|
190
186
|
- label: Example Menu
|
|
@@ -204,11 +200,11 @@ Create a data file in the _data directory and use the following format (if using
|
|
|
204
200
|
link: /blog/
|
|
205
201
|
```
|
|
206
202
|
|
|
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
|
|
203
|
+
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
204
|
|
|
209
205
|
#### Multiple menus
|
|
210
206
|
|
|
211
|
-
You may make multiple menus in the same file, separated by
|
|
207
|
+
You may make multiple menus in the same file, separated by labels.
|
|
212
208
|
|
|
213
209
|
```yaml
|
|
214
210
|
- label: Menu Label
|
|
@@ -232,9 +228,7 @@ You may make multiple menus in the same file, separated by the label
|
|
|
232
228
|
|
|
233
229
|
### Tabs
|
|
234
230
|
|
|
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.
|
|
231
|
+
**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
232
|
|
|
239
233
|
```yaml
|
|
240
234
|
title: Page with tabs
|
|
@@ -249,7 +243,7 @@ Tabs can be used in conjunction with menubar and/or sidebar if you wish.
|
|
|
249
243
|
|
|
250
244
|
#### Creating a tabs data file
|
|
251
245
|
|
|
252
|
-
Create a data file in the _data directory and use the following format (if using yml)
|
|
246
|
+
Create a data file in the `_data` directory and use the following format (if using yml).
|
|
253
247
|
|
|
254
248
|
```yaml
|
|
255
249
|
alignment: is-left
|
|
@@ -272,7 +266,7 @@ items:
|
|
|
272
266
|
|
|
273
267
|
#### Settings
|
|
274
268
|
|
|
275
|
-
You can control the alignment, style and size of
|
|
269
|
+
You can control the alignment, style, and size of tabs by using the relevant [Bulma tabs classes](https://bulma.io/documentation/components/tabs/).
|
|
276
270
|
|
|
277
271
|
#### Active Tab Highlighting
|
|
278
272
|
|
|
@@ -280,9 +274,7 @@ It will automatically mark the active tab based on the current page.
|
|
|
280
274
|
|
|
281
275
|
#### Icons
|
|
282
276
|
|
|
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.
|
|
277
|
+
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
278
|
|
|
287
279
|
### Notifications
|
|
288
280
|
|
|
@@ -328,15 +320,11 @@ You can overwrite the default style (is-primary) by passing in the style in the
|
|
|
328
320
|
|
|
329
321
|
### Google Analytics
|
|
330
322
|
|
|
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
|
|
323
|
+
**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
324
|
|
|
335
325
|
### Footer
|
|
336
326
|
|
|
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
|
|
327
|
+
**New in 0.4.1** - To add some footer links, create a yaml file in the `_data` directory using the following format.
|
|
340
328
|
|
|
341
329
|
```yaml
|
|
342
330
|
- name: Blog
|
|
@@ -347,7 +335,7 @@ To add some footer links, create a yaml file in the `_data` directory using the
|
|
|
347
335
|
link: /privacy-policy/
|
|
348
336
|
```
|
|
349
337
|
|
|
350
|
-
Then add the name of your yaml file (without the .yml extension) into the footer_menu setting in the `_config.yml
|
|
338
|
+
Then add the name of your yaml file (without the .yml extension) into the `footer_menu` setting in the `_config.yml`.
|
|
351
339
|
|
|
352
340
|
```yaml
|
|
353
341
|
footer_menu: example_footer_menu
|
|
@@ -355,19 +343,15 @@ footer_menu: example_footer_menu
|
|
|
355
343
|
|
|
356
344
|
#### Hiding the footer
|
|
357
345
|
|
|
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.
|
|
346
|
+
**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
347
|
|
|
362
348
|
### Products
|
|
363
349
|
|
|
364
|
-
**New in 0.5**
|
|
365
|
-
|
|
366
|
-
Now you can add simple product pages to your site using collections.
|
|
350
|
+
**New in 0.5** - Now you can add simple product pages to your site using collections.
|
|
367
351
|
|
|
368
352
|
#### Product pages
|
|
369
353
|
|
|
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.
|
|
354
|
+
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
355
|
|
|
372
356
|
```yaml
|
|
373
357
|
title: Product 1 Name
|
|
@@ -405,7 +389,7 @@ You can also set default product page values here if you like, such as the layou
|
|
|
405
389
|
|
|
406
390
|
#### Product Reviews
|
|
407
391
|
|
|
408
|
-
To add reviews to your product page, create a `reviews` directory in the `_data` directory and add a
|
|
392
|
+
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
393
|
|
|
410
394
|
```yaml
|
|
411
395
|
- name: Mr E Xample
|
|
@@ -424,7 +408,7 @@ To add reviews to your product page, create a `reviews` directory in the `_data`
|
|
|
424
408
|
The product worked exactly as described.
|
|
425
409
|
```
|
|
426
410
|
|
|
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
|
|
411
|
+
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
412
|
|
|
429
413
|
#### Product Category Page
|
|
430
414
|
|
|
@@ -440,23 +424,19 @@ sort: title
|
|
|
440
424
|
|
|
441
425
|
### Scripts
|
|
442
426
|
|
|
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.
|
|
427
|
+
**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
428
|
|
|
447
429
|
### Callouts
|
|
448
430
|
|
|
449
|
-
**New in 0.5.4**
|
|
450
|
-
|
|
451
|
-
You can now add callouts to a page to make a landing page style layout.
|
|
431
|
+
**New in 0.5.4** - You can now add callouts to a page to make a landing page style layout.
|
|
452
432
|
|
|
453
433
|
#### Create a callout data file
|
|
454
434
|
|
|
455
435
|
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
436
|
|
|
457
|
-
**New in 0.5.7** You can set the height of the callouts in the data file, such as is-small
|
|
437
|
+
**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
438
|
|
|
459
|
-
The items have
|
|
439
|
+
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
440
|
|
|
461
441
|
```yaml
|
|
462
442
|
style: is-light
|
|
@@ -476,7 +456,7 @@ items:
|
|
|
476
456
|
|
|
477
457
|
#### Set the callouts in the frontmatter
|
|
478
458
|
|
|
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.
|
|
459
|
+
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
460
|
|
|
481
461
|
```yaml
|
|
482
462
|
layout: page
|
|
@@ -487,7 +467,7 @@ callouts: example_callouts
|
|
|
487
467
|
|
|
488
468
|
### Favicon
|
|
489
469
|
|
|
490
|
-
The default favicon path is `{{ site.baseurl }}/favicon.png` but you can overwrite it in the
|
|
470
|
+
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
471
|
|
|
492
472
|
### Showcases
|
|
493
473
|
|
|
@@ -495,13 +475,13 @@ Showcases allow you to display your work to others using a simple layout.
|
|
|
495
475
|
|
|
496
476
|
#### Creating A Showcase Datafile
|
|
497
477
|
|
|
498
|
-
Create a datafile in your
|
|
478
|
+
Create a datafile in your site's `_data` directory in the following format. Subtitle, features and tags are not required.
|
|
499
479
|
|
|
500
|
-
The description text accepts
|
|
480
|
+
The description text accepts Markdown and is run through the markdownify filter on the page.
|
|
501
481
|
|
|
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.
|
|
482
|
+
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
483
|
|
|
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
|
|
484
|
+
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
485
|
|
|
506
486
|
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
487
|
|
|
@@ -510,7 +490,7 @@ intro: |-
|
|
|
510
490
|
This is some introduction text for the showcases.
|
|
511
491
|
|
|
512
492
|
## Example Heading
|
|
513
|
-
It can convert
|
|
493
|
+
It can convert Markdown format
|
|
514
494
|
|
|
515
495
|
items:
|
|
516
496
|
- title: Example showcase item
|
|
@@ -602,7 +582,7 @@ Start by creating a gallery data file using the below format, for example `my_ga
|
|
|
602
582
|
large_link: https://via.placeholder.com/1200x675
|
|
603
583
|
alt: The alt text for the image
|
|
604
584
|
description: |-
|
|
605
|
-
The image description can be written in **
|
|
585
|
+
The image description can be written in **Markdown** if required
|
|
606
586
|
ratio: is-16by9
|
|
607
587
|
- link: https://via.placeholder.com/800x600
|
|
608
588
|
large_link: https://via.placeholder.com/1200x675
|
|
@@ -612,13 +592,13 @@ Start by creating a gallery data file using the below format, for example `my_ga
|
|
|
612
592
|
```
|
|
613
593
|
|
|
614
594
|
* 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
|
|
616
|
-
* The alt will be used as the
|
|
617
|
-
* The large_link displays in a modal when the image is clicked
|
|
595
|
+
* The description can be plaintext or it can be Markdown if required.
|
|
596
|
+
* The alt will be used as the image's alt text.
|
|
597
|
+
* The large_link displays in a modal when the image is clicked.
|
|
618
598
|
|
|
619
599
|
#### Displaying the gallery
|
|
620
600
|
|
|
621
|
-
In your
|
|
601
|
+
In your page's front matter add a gallery with the datafile's filename without the extension.
|
|
622
602
|
|
|
623
603
|
```yaml
|
|
624
604
|
layout: page
|
|
@@ -628,7 +608,14 @@ gallery: my_gallery
|
|
|
628
608
|
|
|
629
609
|
### Disqus
|
|
630
610
|
|
|
631
|
-
Disqus comments are available for posts. To be able to use them, you need to set your disqus shortname in `_config.yml`.
|
|
611
|
+
Disqus comments are available for posts. To be able to use them, you need to set your disqus shortname in `_config.yml`.
|
|
612
|
+
```
|
|
613
|
+
disqus.shortname=<example-com.disqus.com>
|
|
614
|
+
```
|
|
615
|
+
|
|
616
|
+
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)
|
|
617
|
+
|
|
618
|
+
Then you need to set your Jekyll environment to production:
|
|
632
619
|
|
|
633
620
|
```JEKYLL_ENV=production bundle exec jekyll build```.
|
|
634
621
|
|
|
@@ -638,7 +625,53 @@ Comments are enabled by default. If you want to disable them, set in the front m
|
|
|
638
625
|
comments: false
|
|
639
626
|
```
|
|
640
627
|
|
|
628
|
+
### Recipe
|
|
629
|
+
|
|
630
|
+
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.
|
|
631
|
+
|
|
632
|
+
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
633
|
|
|
634
|
+
Create a list in the front matter for the ingredients, then the method steps and it will automatically be added to the page.
|
|
635
|
+
|
|
636
|
+
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.
|
|
637
|
+
|
|
638
|
+
```yaml
|
|
639
|
+
layout: recipe
|
|
640
|
+
title: An Example Recipe Page
|
|
641
|
+
subtitle: Tastes great and easy to cook
|
|
642
|
+
author: CS Rhymes
|
|
643
|
+
date: 2021-03-02
|
|
644
|
+
show_sidebar: false
|
|
645
|
+
image: /bulma-clan-theme/img/recipe-example.jpg
|
|
646
|
+
hero_image: /bulma-clean-theme/img/recipe-example.jpg
|
|
647
|
+
ingredients:
|
|
648
|
+
- 1tsp vegetable oil
|
|
649
|
+
- 2 Carrots, finely diced
|
|
650
|
+
- 1 Onion, finely dices
|
|
651
|
+
- 1 Celery stick, finely diced
|
|
652
|
+
- 2 Cloves of Garlic, crushed
|
|
653
|
+
- 400g lean Minced Beef
|
|
654
|
+
- 400g tin of Chopped Tomatoes
|
|
655
|
+
- 2tbsp Tomato Puree
|
|
656
|
+
- 300ml Beef Stock
|
|
657
|
+
- 1tsp Worcestershire Sauce
|
|
658
|
+
- 2tsp Italian Herbs
|
|
659
|
+
- Salt and Pepper
|
|
660
|
+
method:
|
|
661
|
+
- 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
|
|
662
|
+
- Add the crushed garlic and cook for 2 more minutes, stiffing occasionally
|
|
663
|
+
- Add the minced beef to the pan, breaking it up with a wooden spoon and cook until browned off
|
|
664
|
+
- 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
|
|
665
|
+
- Bring to a gentle simmer and cook for 30 minutes
|
|
666
|
+
prep_time: PT10M
|
|
667
|
+
cook_time: PT1H
|
|
668
|
+
total_time: PT1H10M
|
|
669
|
+
keywords: recipe,cooking
|
|
670
|
+
recipie_yield: 4
|
|
671
|
+
recipe_category: Main course
|
|
672
|
+
recipe_cuisine: Italian
|
|
673
|
+
calories: 500 calories
|
|
674
|
+
```
|
|
642
675
|
|
|
643
676
|
## Contributing
|
|
644
677
|
|
|
@@ -648,7 +681,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/chrisr
|
|
|
648
681
|
|
|
649
682
|
To set up your environment to develop this theme, run `bundle install`.
|
|
650
683
|
|
|
651
|
-
Your theme is
|
|
684
|
+
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
685
|
|
|
653
686
|
## License
|
|
654
687
|
|
|
@@ -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>
|
data/_includes/youtube.html
CHANGED
|
@@ -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
|
>
|
data/_layouts/default.html
CHANGED
|
@@ -1,17 +1,19 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
1
2
|
{% if page.menubar or page.menubar_toc %}
|
|
2
|
-
|
|
3
|
+
{% assign has_left_sidebar = true %}
|
|
3
4
|
{% endif %}
|
|
4
5
|
|
|
5
|
-
{% if page.show_sidebar and has_left_sidebar %}
|
|
6
|
-
|
|
7
|
-
{% elsif page.show_sidebar or has_left_sidebar %}
|
|
8
|
-
|
|
9
|
-
{% else %}
|
|
10
|
-
|
|
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
|
-
|
|
14
|
-
|
|
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 %}
|
|
@@ -54,4 +56,3 @@
|
|
|
54
56
|
{%- include footer-scripts.html -%}
|
|
55
57
|
</body>
|
|
56
58
|
</html>
|
|
57
|
-
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
layout: default
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<script type="application/ld+json">
|
|
6
|
+
{
|
|
7
|
+
"@context": "https://schema.org/",
|
|
8
|
+
"@type": "Recipe",
|
|
9
|
+
"name": "{{ page.title }}",
|
|
10
|
+
"image": [
|
|
11
|
+
"{{ page.image }}"
|
|
12
|
+
],
|
|
13
|
+
"author": {
|
|
14
|
+
"@type": "Person",
|
|
15
|
+
"name": "{{ page.author }}"
|
|
16
|
+
},
|
|
17
|
+
"datePublished": "{{ page.date }}",
|
|
18
|
+
"description": "{{ page.description }}",
|
|
19
|
+
"prepTime": "{{ page.prep_time }}",
|
|
20
|
+
"cookTime": "{{ page.cook_time }}",
|
|
21
|
+
"totalTime": "{{ page.total_time }}",
|
|
22
|
+
"keywords": "{{ page.keywords }}",
|
|
23
|
+
"recipeYield": "{{ page.recipe_yield }}",
|
|
24
|
+
"recipeCategory": "{{ page.recipe_category }}",
|
|
25
|
+
"recipeCuisine": "{{ page.recipe_cuisine }}",
|
|
26
|
+
{% if page.calories %}
|
|
27
|
+
"nutrition": {
|
|
28
|
+
"@type": "NutritionInformation",
|
|
29
|
+
"calories": "{{ page.calories }}"
|
|
30
|
+
},
|
|
31
|
+
{% endif %}
|
|
32
|
+
"recipeIngredient":
|
|
33
|
+
{{ page.ingredients | jsonify }},
|
|
34
|
+
"recipeInstructions": [
|
|
35
|
+
{% for step in page.method %}
|
|
36
|
+
{
|
|
37
|
+
"@type": "HowToStep",
|
|
38
|
+
"text": "{{ step }}"
|
|
39
|
+
{% if forloop.last == true %}
|
|
40
|
+
}
|
|
41
|
+
{% else %}
|
|
42
|
+
},
|
|
43
|
+
{% endif %}
|
|
44
|
+
{% endfor %}
|
|
45
|
+
]
|
|
46
|
+
}
|
|
47
|
+
</script>
|
|
48
|
+
|
|
49
|
+
<div class="columns is-multiline">
|
|
50
|
+
<div class="column is-4">
|
|
51
|
+
<div class="box">
|
|
52
|
+
<p class="title is-4">Ingredients</p>
|
|
53
|
+
<div class="content">
|
|
54
|
+
<ul>
|
|
55
|
+
{% for ingredient in page.ingredients %}
|
|
56
|
+
<li>{{ ingredient }}</li>
|
|
57
|
+
{% endfor %}
|
|
58
|
+
</ul>
|
|
59
|
+
</div>
|
|
60
|
+
</div>
|
|
61
|
+
</div>
|
|
62
|
+
<div class="column is-8">
|
|
63
|
+
<p class="title is-4">Method</p>
|
|
64
|
+
<div class="content">
|
|
65
|
+
<ol>
|
|
66
|
+
{% for step in page.method %}
|
|
67
|
+
<li>{{ step }}</li>
|
|
68
|
+
{% endfor %}
|
|
69
|
+
</ol>
|
|
70
|
+
<p>Published: {{ page.date | date: "%b %-d, %Y" }} by {{ page.author }}</p>
|
|
71
|
+
</div>
|
|
72
|
+
<div class="content">
|
|
73
|
+
{{ content }}
|
|
74
|
+
</div>
|
|
75
|
+
</div>
|
|
76
|
+
</div>
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: bulma-clean-theme
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: '0.11'
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- chrisrhymes
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-
|
|
11
|
+
date: 2021-03-13 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -156,6 +156,7 @@ files:
|
|
|
156
156
|
- _includes/tabs.html
|
|
157
157
|
- _includes/tag.html
|
|
158
158
|
- _includes/toc.html
|
|
159
|
+
- _includes/vimeo.html
|
|
159
160
|
- _includes/youtube.html
|
|
160
161
|
- _layouts/blog.html
|
|
161
162
|
- _layouts/default.html
|
|
@@ -163,11 +164,11 @@ files:
|
|
|
163
164
|
- _layouts/post.html
|
|
164
165
|
- _layouts/product-category.html
|
|
165
166
|
- _layouts/product.html
|
|
167
|
+
- _layouts/recipe.html
|
|
166
168
|
- _posts/2018-05-28-why-use-a-static-site-generator.markdown
|
|
167
169
|
- _posts/2019-02-09-getting-started-with-bulma-clean-theme.markdown
|
|
168
170
|
- _posts/2019-07-23-introducing-some-new-layouts-to-bulma-clean-theme.markdown
|
|
169
171
|
- _posts/2020-05-08-creating-a-docs-site-with-bulma-clean-theme.markdown
|
|
170
|
-
- _posts/2020-10-17-post-with-summary.md
|
|
171
172
|
- _sass/_layout.scss
|
|
172
173
|
- _sass/_main.scss
|
|
173
174
|
- _sass/_showcase.scss
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
layout: post
|
|
3
|
-
title: Example post with a summary
|
|
4
|
-
summary: |-
|
|
5
|
-
This is the custom summary for the post.
|
|
6
|
-
|
|
7
|
-
It can be in **markdown format** if required.
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
This is the text for the post. It won't be used as the excerpt as it will use the custom summary set in the post instead.
|
|
11
|
-
|
|
12
|
-
If the summary is not set it will use the default excerpt generated by Jekyll.
|
|
13
|
-
|
|
14
|
-
To use a custom summary, set the `summary` in the post's front matter.
|
|
15
|
-
|
|
16
|
-
```yaml
|
|
17
|
-
layout: post
|
|
18
|
-
title: Example post with a summary
|
|
19
|
-
summary: |-
|
|
20
|
-
This is the custom summary for the post.
|
|
21
|
-
|
|
22
|
-
It can be in **markdown format** if required.
|
|
23
|
-
```
|