beautiful-jekyll-theme 2.3.0 → 5.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/404.html +1 -1
  3. data/README.md +119 -139
  4. data/_data/ui-text.yml +1 -1
  5. data/_includes/comments.html +2 -2
  6. data/_includes/disqus.html +11 -11
  7. data/_includes/ext-css.html +2 -2
  8. data/_includes/fb-comment.html +12 -10
  9. data/_includes/footer-minimal.html +11 -11
  10. data/_includes/footer-scripts.html +8 -2
  11. data/_includes/footer.html +15 -11
  12. data/_includes/google_analytics.html +8 -8
  13. data/_includes/gtag.html +2 -3
  14. data/_includes/gtm_body.html +3 -4
  15. data/_includes/gtm_head.html +9 -7
  16. data/_includes/head.html +90 -74
  17. data/_includes/header.html +52 -40
  18. data/_includes/nav.html +33 -44
  19. data/_includes/readtime.html +10 -10
  20. data/_includes/social-networks-links.html +57 -21
  21. data/_includes/social-share.html +8 -3
  22. data/_includes/staticman-comments.html +8 -8
  23. data/_includes/utterances-comment.html +1 -1
  24. data/_layouts/base.html +26 -21
  25. data/_layouts/default.html +17 -1
  26. data/_layouts/home.html +58 -28
  27. data/_layouts/minimal.html +28 -6
  28. data/_layouts/page.html +19 -2
  29. data/_layouts/post.html +25 -13
  30. data/assets/css/{main-minimal.css → beautifuljekyll-minimal.css} +3 -3
  31. data/assets/css/{main.css → beautifuljekyll.css} +470 -297
  32. data/assets/css/staticman.css +2 -2
  33. data/assets/img/thumb.png +0 -0
  34. data/assets/js/beautifuljekyll.js +114 -0
  35. data/assets/js/staticman.js +13 -13
  36. data/feed.xml +4 -3
  37. data/staticman.yml +110 -0
  38. metadata +36 -16
  39. data/assets/css/bootstrap-theme.css +0 -476
  40. data/assets/css/bootstrap-theme.css.map +0 -1
  41. data/assets/css/bootstrap-theme.min.css +0 -5
  42. data/assets/css/bootstrap.css +0 -6566
  43. data/assets/css/bootstrap.css.map +0 -1
  44. data/assets/css/bootstrap.min.css +0 -5
  45. data/assets/css/normalize.css +0 -427
  46. data/assets/js/bootstrap.js +0 -2306
  47. data/assets/js/bootstrap.min.js +0 -7
  48. data/assets/js/jquery-1.11.2.min.js +0 -4
  49. data/assets/js/main.js +0 -140
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 16d6e98a7d9ba9dac7b0d13b98bde18eed1cdfa4ddb1d471c79443e562757f7b
4
- data.tar.gz: f3fc30b9193b7244a370242d565974c9af79ff527b1f70731a2571c795a76c53
3
+ metadata.gz: f39224015daeee1419c359a845eadddc54f33e5829aa71e5b4519b209f27bf94
4
+ data.tar.gz: ddd575749dcb0a980570c42296de37f3a60de01bcbeeb56456819426479840d8
5
5
  SHA512:
6
- metadata.gz: 9220bbdd313a57fa061f553764db42e80286e01dc7870cf9f1cba83a248212c5ed58ae14902dea2c90371cdb246dfdc4facc05aa3fd11293a8cfc6319d96aa3e
7
- data.tar.gz: 9a761b938b7388edc553039cb72f2a6bf1f81ca9abf55ccb6be9c90de1789b31033de30f00584bb5a236fb4c2046c0c113f27cab6b2dc1fbed948eb06a40a7c0
6
+ metadata.gz: 0ddc81e85fa0ecb9daa7f35a9457efe4c89ae0db9fd1efbb74f3f0f6eb6a61d1dab138ba3970e77448071d32c8df63ff5478e1ca8bbd4803fe4b35bc55f8498f
7
+ data.tar.gz: f4613691b90e7df24166a65c5a4d5fc56a0c015fc54125e93021aae7bf98773e69785bca05e391c43ba5784fc529272c4b6702df3dda04771c9079e714a91a72
data/404.html CHANGED
@@ -9,5 +9,5 @@ permalink: /404.html
9
9
  <h1>Move along. (404 error)</h1>
10
10
  <br/>
11
11
 
12
- <img src="{{ 'assets/img/404-southpark.jpg' | relative_url }}" />
12
+ <img src="{{ 'assets/img/404-southpark.jpg' | relative_url }}" alt="Not found" />
13
13
  </div>
data/README.md CHANGED
@@ -1,55 +1,57 @@
1
+ [![](https://i.imgur.com/zNBkzj1.png)](https://beautifuljekyll.com/plans/)
2
+
1
3
  # Beautiful Jekyll
2
4
 
3
- ![Beautiful Jekyll CI](https://github.com/daattali/beautiful-jekyll/workflows/Beautiful%20Jekyll%20CI/badge.svg)
5
+ [![xscode](https://img.shields.io/badge/Available%20on-xs%3Acode-blue?style=?style=plastic&logo=appveyor&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAZQTFRF////////VXz1bAAAAAJ0Uk5T/wDltzBKAAAAlUlEQVR42uzXSwqAMAwE0Mn9L+3Ggtgkk35QwcnSJo9S+yGwM9DCooCbgn4YrJ4CIPUcQF7/XSBbx2TEz4sAZ2q1RAECBAiYBlCtvwN+KiYAlG7UDGj59MViT9hOwEqAhYCtAsUZvL6I6W8c2wcbd+LIWSCHSTeSAAECngN4xxIDSK9f4B9t377Wd7H5Nt7/Xz8eAgwAvesLRjYYPuUAAAAASUVORK5CYII=)](https://xscode.com/daattali/beautiful-jekyll)
4
6
  [![Gem Version](https://badge.fury.io/rb/beautiful-jekyll-theme.svg)](https://badge.fury.io/rb/beautiful-jekyll-theme)
5
7
 
6
- > *Copyright 2020 [Dean Attali](https://deanattali.com)*
7
-
8
- **Beautiful Jekyll** is a ready-to-use template to help you create an awesome website quickly. Perfect for personal sites, blogs, or simple project websites. [Check out a demo](https://beautifuljekyll.com) of what you'll get after just two minutes. You can also look at [my personal website](https://deanattali.com) to see it in use, or see examples of websites other people created using this theme [below](#showcased-users-success-stories).
8
+ > By [Dean Attali](https://deanattali.com) &middot; [Demo](https://beautifuljekyll.com/)
9
9
 
10
- **If you enjoy this theme, please consider [supporting me](http://paypal.me/daattali) or [sponsoring me](https://github.com/sponsors/daattali) for developing and maintaining it for over 5 years.**
10
+ **Beautiful Jekyll** is a ready-to-use template to help you create a beautiful website quickly. Perfect for personal sites, blogs, or simple project websites. [Check out a demo](https://beautifuljekyll.com) of what you'll get after just two minutes. You can also look at [my personal website](https://deanattali.com) or [my consulting website](https://attalitech.com) to see it in use, or see [examples of websites](http://beautifuljekyll.com/examples) other people created using this theme.
11
11
 
12
- <p align="center">
13
- <a style="display: inline-block;" href="https://paypal.me/daattali">
14
- <img height="40" src="https://camo.githubusercontent.com/0e9e5cac101f7093336b4589c380ab5dcfdcbab0/68747470733a2f2f63646e2e6a7364656c6976722e6e65742f67682f74776f6c66736f6e2f70617970616c2d6769746875622d627574746f6e40312e302e302f646973742f627574746f6e2e737667" />
15
- </a>&nbsp;&nbsp;
16
- <a style="display: inline-block;" href="https://github.com/sponsors/daattali">
17
- <img height="40" src="https://i.imgur.com/034B8vq.png" />
18
- </a>
19
- </p>
12
+ **If you enjoy Beautiful Jekyll, please consider [supporting me](https://github.com/sponsors/daattali) for over 5 years of development (and to unlock rewards!) ❤**
20
13
 
21
- ### Table of contents
14
+ ## Table of contents
22
15
 
23
16
  - [Features](#features)
24
- - [Build your website in 3 steps](#build-your-website-in-3-steps)
17
+ - [Sponsors 🏆](#sponsors)
18
+ - [**Build your website in 3 steps**](#build-your-website-in-3-steps)
19
+ - [Plans](#plans)
25
20
  - [Add your own content](#add-your-own-content)
26
- - [Last important thing: parameters for each page](#last-important-thing-parameters-for-each-page)
27
- - [Supported YAML front matter parameters](#supported-yaml-front-matter-parameters)
28
- - [Showcased users (success stories!)](#showcased-users-success-stories)
21
+ - [Customizing parameters for each page](#customizing-parameters-for-each-page)
22
+ - [Supported parameters](#supported-parameters)
23
+ - [Featured users (success stories!)](#featured-users-success-stories)
29
24
  - [FAQ and support](#faq-and-support)
30
25
  - [Credits and contributions](#credits)
31
26
 
32
- ## Features
27
+ # Features
28
+
29
+ Check out [*What's New?*](https://beautifuljekyll.com/updates/) to see the latest features.
33
30
 
34
31
  - **SIMPLE**: The primary goal of Beautiful Jekyll is to allow literally *anyone* to create a website in a few minutes.
35
- - **Mobile-first**: Designed to look great on both large-screen and small-screen (mobile) devices.
36
- - **Highly customizable**: Many personalization settings such as changing the background colour/image, adding a logo.
37
- - **Two-level navigation menu**: If you have many pages and your menu is getting cluttered, separate your menu into two levels.
38
- - **Flexible usage**: Install Beautiful Jekyll directly from GitHub or using a Ruby gem - choose the right [development method](#build-your-website-in-3-steps) for you.
39
- - **Battle-tested**: By using Beautiful Jekyll, you'll be joining tens of thousands of users who used this theme since 2015.
40
- - **Links to your social media**: You can easily add links to any of your social media accounts in the footer of every page.
41
- - **Comments support**: Add comments to any page using one of the supported commenting platforms: [Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), [Utterances](https://utteranc.es/), or [Staticman](https://staticman.net).
42
- - **Sharing blog posts on social media**: By default, all blog posts have buttons to allow people to share on Twitter/Facebook/LinkedIn.
32
+ - **Modern**: Uses the latest best practices and technologies to achieve nearly perfect scores on Google Chrome's Audit.
33
+ - **Mobile-first**: Designed to look great on both large-screen and small-screen (mobile) devices.
34
+ - **Highly customizable**: Many personalization settings such as changing the background colour/image, adding a logo.
35
+ - **Flexible usage**: Use Beautiful Jekyll directly on GitHub or via a Ruby gem - choose the best [development method](#build-your-website-in-3-steps) for you.
36
+ - **Battle-tested**: By using Beautiful Jekyll, you'll be joining 50,000+ users enjoying this theme since 2015.
37
+ - **SEO and social media support**: Customize how your site looks on Google and when shared on social media.
38
+ - **Comments support**: Add comments to any page using either [Disqus](https://disqus.com/), [Facebook comments](https://developers.facebook.com/docs/plugins/comments), [Utterances](https://utteranc.es/), or [Staticman](https://staticman.net).
43
39
  - **Tags**: Any blog post can be tagged with keywords, and an index page showing all the tags is automatically generated.
44
- - **Tracking analytics**: Easily integrate Google Analytics, or other analytics platforms, to track visits to your website.
45
- - **Photos support**: Any page can have a cover photo around its title, and any blog post can have an associated image.
46
- - **More advanced features**: I wrote [a blog post](https://deanattali.com/2015/03/12/beautiful-jekyll-how-to-build-a-site-in-minutes/) describing some more advanced features that I used in my website that can be used in any beautiful-jekyll site.
40
+ - **Analytics**: Easily integrate Google Analytics, or other analytics platforms, to track visits to your website.
41
+ - **Photos support**: Any page can have a full-width cover photo and thumbnail.
42
+ - **RSS**: An RSS feed is automatically created, so you can even host a podcast easily with Beautiful Jekyll.
43
+
44
+ <h2 id="sponsors">Sponsors 🏆</h2>
45
+
46
+ > There are no sponsors yet
47
+
48
+ [Become the first sponsor for Beautiful Jekyll and unlock special rewards\!](https://github.com/sponsors/daattali/sponsorships?tier_id=39856)
47
49
 
48
- ## Build your website in 3 steps
50
+ # Build your website in 3 steps
49
51
 
50
52
  There's a very easy way to use this theme, and there's a hard way. For most people (including myself!), I suggest going the easy route. If you're an advanced user and want to tinker with the hard way (using ruby gems), then [skip the easy way](https://github.com/daattali/beautiful-jekyll#the-hard-way-using-ruby-gems) if you know what you're doing.
51
53
 
52
- ### The easy way (recommended!)
54
+ ## The easy way (recommended!)
53
55
 
54
56
  Getting started is *literally* as easy as 1-2-3 :smile:
55
57
 
@@ -57,47 +59,57 @@ Scroll down to see the steps involved, but here is a 40-second video just as a r
57
59
 
58
60
  ![Installation steps](assets/img/install-steps.gif)
59
61
 
60
- #### 1. Fork this project
62
+ ### 1. Fork this project
61
63
 
62
64
  Fork this project by clicking the __*Fork*__ button at the top right corner of this page. Forking means that you now copied this entire project and all the files into your account.
63
65
 
64
- #### 2. Rename the project to `<yourusername>.github.io`
66
+ ### 2. Rename the project to `<yourusername>.github.io`
65
67
 
66
- Click on __*Settings*__ at the top (the cog icon) and on that page you'll have an option to rename the project (*repository name*). This will create a website with the **Beautiful Jekyll** template that will be available at `https://<yourusername>.github.io` within a couple minutes. Check out the [FAQ](#faq-and-support) if you want to use a different project name.
68
+ Click on __*Settings*__ at the top (the cog icon) and on that page you'll have an option to rename the project (*Repository name*). This will create a website with the **Beautiful Jekyll** template that will be available at `https://<yourusername>.github.io` within a couple minutes (check out the [FAQ](https://beautifuljekyll.com/faq/#custom-domain) if you want to use a different project name). If after a few minutes your website is still not ready, try making any edit to any file, just to force GitHub to re-build your site.
67
69
 
68
- #### 3. Customize your website settings
70
+ ### 3. Customize your website settings
69
71
 
70
72
  Edit the `_config.yml` file to change any settings you want. To edit the file, click on it to view the file and then click on the pencil icon to edit it (watch the video tutorial above if you're confused). The settings in the file are self-explanatory and I added comments inside the file to help you understand what each setting does. Any line that begins with a hashtag (`#`) is a comment, and the other lines are actual settings.
71
73
 
72
- #### 4. Congratulations! You have a website!
74
+ Note that in the video above I only edited one setting in the `_config.yml` file. **You should actually go through the rest of the settings as well. Don't be lazy, go through all the settings!**
73
75
 
74
- After you save your changes to the config file (by clicking on *Commit changes* as the video tutorial shows), your website should be ready in a minute or two at `https://<yourusername>.github.io`. Every time you make a change to any file, your website will get rebuilt and should be updated in about a minute or so. Your website will be initialized with several sample blog posts and a couple other pages.
76
+ ### 4. Congratulations! You have a website!
75
77
 
76
- Note that in the video above I only edited one setting in the `_config.yml` file. **You should actually go through the rest of the settings as well. Don't be lazy, go through all the settings :)**
78
+ After you save your changes to the `_config.yml` file (by clicking on *Commit changes* as the video tutorial shows), your website should be ready in a minute or two at `https://<yourusername>.github.io`. Every time you make a change to any file, your website will get rebuilt and should be updated in about a minute or so. Your website will be initialized with several sample blog posts and a couple other pages.
77
79
 
78
- ### The hard way (using ruby gems)
80
+ Note that this was the easy way to *create* your website, but it does come at a cost: when Beautiful Jekyll gains new features in the future, *updating* your website to include all the latest features is cumbersome. See the [FAQ](https://beautifuljekyll.com/faq/#updating) for help with upgrading in the future.
79
81
 
80
- If you followed the easy method above, then you already have your site and you can skip this section! If you want to install beautiful-jekyll using ruby gems instead, follow the [advanced installation instructions](https://beautifuljekyll.com/getstarted/#install-steps-hard).
82
+ ## The hard way (using ruby gems)
81
83
 
84
+ If you followed the easy method above, then you already have your site and you can skip this section! If you want to use Beautiful Jekyll as a ruby gem instead, follow the [advanced installation instructions](https://beautifuljekyll.com/getstarted/#install-steps-hard). This is harder to set up initially, but it makes it super easy to keep your site up to date with Beautiful Jekyll when more features are added in the future.
82
85
 
83
- ## Add your own content
86
+ # Plans
84
87
 
85
- To add pages to your site, you can either write a markdown file (`.md`) or you can write an HTML file directly. It's much easier to write markdown than HTML, so I suggest you do that (use [this great tutorial](https://markdowntutorial.com/) if you need to learn markdown in 5 minutes). You can look at some files on this site to get an idea of how to write markdown. To look at existing files, click on any file that ends in `.md`, for example [`aboutme.md`](./aboutme.md). On the next page you can see some nicely formatted text (there's a word in bold, a link, a few bullet points), and if you click on the pencil icon to edit the file, you'll see the markdown that generated the pretty text. Very easy!
88
+ Beautiful Jekyll is, and always will be, free. But if you want to remove the Beautiful Jekyll ad from your website, use a Dark Mode skin, unlock other special rewards, or simply support my development efforts, [check out the different plans](https://beautifuljekyll.com/plans).
89
+
90
+ # Add your own content
91
+
92
+ To add pages to your site, you can either write a markdown file (`.md`) or you can write an HTML file. It's much easier to write markdown than HTML, so I suggest you do that ([here's a great tutorial](https://markdowntutorial.com/) if you need to learn markdown in 5 minutes).
93
+
94
+ To see an example of a markdown file, click on any file that ends in `.md`, for example [`aboutme.md`](./aboutme.md). On that page you can see some nicely formatted text (there's a word in bold, a link, a few bullet points), and if you click on the pencil icon to edit the file, you'll see the markdown code that generated the pretty text. Very easy!
86
95
 
87
96
  In contrast, look at [`tags.html`](./tags.html). That's how your write HTML - not as pretty. So stick with markdown if you don't know HTML.
88
97
 
98
+ Any markdown or HTML file that you create will be available on your website under `https://<yourusername>.github.io/<pagename>`. For example, if you create a file `about.md` (or `about.html`) then it'll exist at `https://<yourusername>.github.io/about`.
99
+
89
100
  Files you create inside the [`_posts`](./_posts) directory will be treated as blog entries. You can look at the existing files there to get an idea of how to write blog posts. Note the format of the blog post files - they must follow the naming convention of `YEAR-MONTH-DAY-title.md`. After you successfully add your own post, you can delete the existing files inside [`_posts`](./_posts) to remove the sample posts, as those are just demo posts to help you learn.
90
101
 
91
- ## Last important thing: parameters for each page
102
+ # Customizing parameters for each page
103
+
104
+ **One last important thing**: In order to have your new pages use this template and not just be plain HTML pages, **you must add [YAML front matter](https://jekyllrb.com/docs/front-matter/) to the top of each page**:
92
105
 
93
- In order to have your new pages use this template and not just be plain HTML pages, **you must add [YAML front matter](https://jekyllrb.com/docs/front-matter/) to the top of each page**. This is where you'll be able to give each page some extra parameters such as a title, a subtitle, or an image. [Below is a list of all available parameters](#supported-yaml-front-matter-parameters). If you don't want to use any parameters on a page (this also means having no title), then use the empty YAML front matter:
94
106
 
95
107
  ```
96
108
  ---
97
109
  ---
98
110
  ```
99
111
 
100
- If you do want to use any parameters, write them between these two lines. For example, you can have this at the top of a page:
112
+ This is where you'll be able to give each page some extra parameters (such as a title, a subtitle, an image, etc - [below is a list of all parameters](#supported-parameters)). Add any parameters you want between these two dashed lines, for example:
101
113
 
102
114
  ```
103
115
  ---
@@ -106,42 +118,72 @@ subtitle: Here you'll find all the ways to get in touch with me
106
118
  ---
107
119
  ```
108
120
 
121
+ If you don't want to use any parameters on a page, you still need to use the two dashed lines. If you don't, then your file will be shown as-is without the Beautiful Jekyll template.
122
+
109
123
  You can look at the top of [`aboutme.md`](https://raw.githubusercontent.com/daattali/beautiful-jekyll/master/aboutme.md) as an example.
110
124
 
111
- **Important takeaway: ALWAYS add the YAML front matter, which is two lines with three dashes, to EVERY page. If you have any parameters, they go between the two lines.**
125
+ **Important takeaway: ALWAYS add the YAML front matter, which is two lines of three dashes, to EVERY page. If you have any parameters, they go between the two lines.**
112
126
 
113
- If you don't include YAML then your file will not use this template.
127
+ # Supported parameters
114
128
 
115
- ## Supported YAML front matter parameters
129
+ Below is a list of the parameters that Beautiful Jekyll supports (any of these can be added to the YAML front matter of any page). Remember to also look in the `_config.yml` file to see additional site-wide settings.
116
130
 
117
- These are the main parameters you can place inside a page's YAML front matter that **Beautiful Jekyll** supports.
131
+ ## Main parameters
132
+
133
+ These are the basic YAML parameters that you are most likely to use on most pages.
118
134
 
119
135
  Parameter | Description
120
136
  ----------- | -----------
121
137
  title | Page or blog post title
122
138
  subtitle | Short description of page or blog post that goes under the title
123
- tags | List of tags to categorize the post. Separate the tags with commas and place them inside square brackets. Example: `[personal, self help, finance]`
124
- bigimg | Include a large full-width image at the top of the page. You can either give the path to a single image, or provide a list of images to cycle through (see [my personal website](https://deanattali.com/) as an example).
125
- comments | If you want do add comments to a specific page, use `comments: true`. Comments are automatically enabled on blog posts; to turn comments off for a specific post, use `comments: false`. Comments only work if you enable at least one provider(Facebook, disqus, staticman) in `_config.yml` file.
126
- show-avatar | If you have an avatar configured in the `_config.yml` but you want to turn it off on a specific page, use `show-avatar: false`. If you want to turn it off by default, locate the line `show-avatar: true` in the file `_config.yml` and change the `true` to `false`; then you can selectively turn it on in specific pages using `show-avatar: true`.
127
- image | If you want to add a personalized image to your blog post that will show up next to the post's excerpt and on the post itself, use `image: /path/to/img`.
128
- readtime | If you want to show how many minutes it will take to read a post in the header, add `readtime: true`.
129
- share-img | If you want to specify an image to use when sharing the page on Facebook or Twitter, then provide the image's full URL here.
130
- social-share | If you don't want to show buttons to share a blog post on social media, use `social-share: false` (this feature is turned on by default).
131
- footer-extra | If you want to include extra information in the footer, create an HTML file in the `_includes/` folder (for example `_includes/myinfo.html`) and set `footer-extra` to the name of the file (for example `footer-extra: myinfo.html`)
132
- nav-short | By default, the navigation bar gets shorter after scrolling down the page. If you want the navigation bar to always be short on a certain page, use `nav-short: true`
133
- use-site-title | If you want to use the site title rather than page title as HTML document title (ie. browser tab title), use `use-site-title: true`. When set, the document title will take the format `Site Title - Site Description` (eg. `My website - A virtual proof that name is awesome!`). By default, it will use `Page Title` if it exists, or `Site Title` otherwise.
134
- language | HTML language code to be set on &lt;html&gt; element (see [W3Schools website](https://www.w3schools.com/tags/ref_language_codes.asp) for more info on this topic). Language can also be set site-wide in `_config.yml`.
135
- layout | What type of page this is (default is `post` for blog posts and `page` for other pages). See _Page types_ section below for more information.
136
- gh-repo   | If you want to show GitHub buttons at the top of a post, this sets the GitHub repo name (eg. `daattali/beautiful-jekyll`). You must also use the `gh-badge` parameter to specify what buttons to show.
139
+ tags | List of tags to categorize the post. Separate the tags with commas and place them inside square brackets. Example: `[personal, analysis, finance]`
140
+ cover-img | Include a large full-width image at the top of the page. You can either provide the path to a single image (eg. `"/path/to/img"`) , or a list of images to cycle through (eg. `["/path/img1", "/path/img2"]`). If you want to add a caption to an image, then the image should be provided as `{"/path/to/img" : "Caption of image"}`.
141
+ thumbnail-img | For blog posts, if you want to add a thumbnail that will show up in the feed, use `thumbnail-img: /path/to/image`. If no thumbnail is provided, then `cover-img` will be used as the thumbnail. You can use `thumbnail-img: ""` to disable a thumbnail.
142
+ comments | If you want do add comments to a specific page, use `comments: true`. Comments only work if you enable one of the comments providers (Facebook, disqus, staticman, utterances) in `_config.yml` file. Comments are automatically enabled on blog posts but not on other pages; to turn comments off for a specific post, use `comments: false`.
143
+
144
+ ## Parameters for SEO and social media sharing
145
+
146
+ These parameters let you control what information shows up when a page is shown in a search engine (such as Google) or gets shared on social media (such as Twitter/Facebook).
147
+
148
+ Parameter | Description
149
+ ----------- | -----------
150
+ share-title | A title for the page. If not provided, then `title` will be used, and if that's missing then the site title (from `_config.yml`) is used.
151
+ share-description | A brief description of the page. If not provided, then `subtitle` will be used, and if that's missing then an excerpt from the page content is used.
152
+ share-img | The image to show. If not provided, then `cover-img` or `thumbnail-img` will be used if one of them is provided.
153
+
154
+ ## Less commonly used parameters
155
+
156
+ These are parameters that you may not use often, but can come in handy sometimes.
157
+
158
+ Parameter | Description
159
+ ----------- | -----------
160
+ readtime | If you want a post to show how many minutes it will take to read it, use `readtime: true`.
161
+ show-avatar | If you have an avatar configured in the `_config.yml` but you want to turn it off on a specific page, use `show-avatar: false`.
162
+ social-share | By default, every blog post has buttons to share the page on social media. If you want to turn this feature off, use `social-share: false`.
163
+ nav-short | By default, the navigation bar gets shorter after scrolling down the page. If you want the navigation bar to always be short on a certain page, use `nav-short: true`
164
+ gh-repo | If you want to show GitHub buttons at the top of a post, this sets the GitHub repo name (eg. `daattali/beautiful-jekyll`). You must also use the `gh-badge` parameter to specify what buttons to show.
137
165
  gh-badge | Select which GitHub buttons to display. Available options are: [star, watch, fork, follow]. You must also use the `gh-repo` parameter to specify the GitHub repo.
166
+ last-updated | If you want to show that a blog post was updated after it was originally released, you can specify an "Updated on" date.
167
+ layout | What type of page this is (default is `post` for blog posts and `page` for other pages). See _Page types_ section below for more information.
168
+
169
+ ## Advanced parameters
170
+
171
+ These are advanced parameters that are only useful for people who need very fine control over their website.
172
+
173
+ Parameter | Description
174
+ ----------- | -----------
175
+ footer-extra | If you want to include extra content below the social media icons in the footer, create an HTML file in the `_includes/` folder (for example `_includes/myinfo.html`) and set `footer-extra` to the name of the file (for example `footer-extra: myinfo.html`). Accepts a single file or a list of files.
176
+ before-content | Similar to `footer-extra`, but used for including HTML before the main content of the page (below the title).
177
+ after-content | Similar to `footer-extra`, but used for including HTML after the main content of the page (above the footer).
178
+ head-extra | Similar to `footer-extra`, but used if you have any HTML code that needs to be included in the `<head>` tag of the page.
179
+ language | HTML language code to be set on the page's &lt;html&gt; element.
180
+ full-width | By default, page content is constrained to a standard width. Use `full-width: true` to allow the content to span the entire width of the window.
138
181
  js | List of local JavaScript files to include in the page (eg. `/assets/js/mypage.js`)
139
182
  ext-js | List of external JavaScript files to include in the page (eg. `//cdnjs.cloudflare.com/ajax/libs/underscore.js/1.8.2/underscore-min.js`). External JavaScript files that support [Subresource Integrity (SRI)](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) can be specified using the `href` and `sri` parameters eg.<br/>`href: "//code.jquery.com/jquery-3.1.1.min.js"`<br/>`sri: "sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8="`
140
183
  css | List of local CSS files to include in the page
141
184
  ext-css | List of external CSS files to include in the page. External CSS files using SRI (see `ext-js` parameter) are also supported.
142
- googlefonts | List of Google fonts to include in the page (eg. `["Monoton", "Lobster"]`)
143
185
 
144
- ### Page types
186
+ ## Page types
145
187
 
146
188
  - **post** - To write a blog post, add a markdown or HTML file in the `_posts` folder. As long as you give it YAML front matter (the two lines of three dashes), it will automatically be rendered like a blog post. Look at the existing blog post files to see examples of how to use YAML parameters in blog posts.
147
189
  - **page** - Any page outside the `_posts` folder that uses YAML front matter will have a very similar style to blog posts.
@@ -149,90 +191,28 @@ googlefonts | List of Google fonts to include in the page (eg. `["Monoton", "Lob
149
191
  - **minimal** - If you want to create a page with minimal styling (ie. without the bulky navigation bar and footer), assign `layout: minimal` to the YAML front matter.
150
192
  - If you want to completely bypass the template engine and just write your own HTML page, simply omit the YAML front matter. Only do this if you know how to write HTML!
151
193
 
152
- ## Showcased users (success stories!)
153
-
154
- Beautiful Jekyll has been used in over 500 websites in its first 6 months, and tens of thousands of times since its inception. Here is a sample of some websites that use Beautiful Jekyll.
155
-
156
- ### Project/company websites
157
-
158
- | Website | Description |
159
- | :------ |:----------- |
160
- | [repidemicsconsortium.org/](https://www.repidemicsconsortium.org/) | R Epidemics Consortium |
161
- | [vaccineimpact.org](https://www.vaccineimpact.org/) | Vaccine Impact Modelling Consortium |
162
- | [derekogle.com/fishR](http://derekogle.com/fishR/) | Using R for Fisheries Analyses |
163
- | [bigdata.juju.solutions](http://bigdata.juju.solutions) | Creating Big Data solutions Juju Solutions |
164
- | [joecks.github.io/clipboard-actions](http://joecks.github.io/clipboard-actions/) | Clipboard Actions - an Android app |
165
- | [deanattali.com/shinyjs](http://deanattali.com/shinyjs/) | shinyjs - an R package |
166
- | [blabel.github.io](http://blabel.github.io) | Library for canonicalising blank node labels in RDF graphs |
167
- | [reactionic.github.io](http://reactionic.github.io) | Create iOS and Android apps with React and Ionic |
168
- | [ja2-stracciatella.github.io](http://ja2-stracciatella.github.io) | Jagged Alliance 2 Stracciatella |
169
- | [ddocent.com](http://ddocent.com/) | RADSeq Bioinformatics and Beyond |
170
- | [guitarlessons.org](https://www.guitarlessons.org/) | Free online guitar lessons for all |
171
- | [terremotocentroitalia.info](https://www.terremotocentroitalia.info/) | Information about the 2016 Italy earthquake |
172
-
173
-
174
- ### Personal websites
175
-
176
- | Website | Who | What |
177
- | :------ |:--- | :--- |
178
- | [deanattali.com](https://deanattali.com) | Dean Attali | Creator of Beautiful Jekyll |
179
- | [ouzor.github.io](http://ouzor.github.io) | Juuso Parkkinen | Data scientist |
180
- | [derekogle.com](http://derekogle.com/) | Derek Ogle | Professor of Mathematical Sciences and Natural Resources |
181
- | [melyanna.github.io](http://melyanna.github.io/) | Melyanna | Shows off her nice art |
182
- | [chauff.github.io](http://chauff.github.io/) | Claudia Hauff | Professor at Delft University of Technology |
183
- | [kootenpv.github.io](http://kootenpv.github.io/) | Pascal van Kooten | Data analytics |
184
- | [sjackman.ca](http://sjackman.ca) | Shaun Jackman | PhD candidate in bioinformatics |
185
- | [anudit.in](http://www.anudit.in/) | Anudit Verma | Engineering student |
186
- | [sharepointoscar.github.io](http://sharepointoscar.github.io) | Oscar Medina | Independent Hacker |
187
- | [ocram85.com](https://ocram85.com) | Marco Blessing | A personal blog about PowerShell and automation |
188
- | [khanna.cc](https://khanna.cc/) | Harry Khanna | Law and software |
189
-
190
- ## FAQ and support
191
-
192
- If you need any help, I suggest heading over to the [Jekyll support forum](https://talk.jekyllrb.com/).
194
+ # Featured users (success stories!)
193
195
 
194
- Beautiful Jekyll is actively used by thousands of people with wildly varying degrees of competency, so it's impossible to answer all the questions that may arise. Below are answers to a few very common questions. Most questions that I get asked are not directly related to this theme, and instead are more general questions about Jekyll or web development. Many such questions can be answered by reading the [Jekyll documentation](https://jekyllrb.com/) or with Google.
196
+ Visit the [Official website](http://beautifuljekyll.com/examples) to see sample websites using Beautiful Jekyll.
195
197
 
196
- #### What if I don't want the website to be `https://<yourusername>.github.io`?
198
+ If you'd like to showcase yourself and join this list, [upgrading to the Individual plan](https://github.com/sponsors/daattali/sponsorships?&tier_id=7362) will give you that publicity plus some other rewards!
197
199
 
198
- Every GitHub user can have one repository (repository = project) named `<yourusername>.github.io` and the website for that repository will be `https://<yourusername>.github.io`.
200
+ # FAQ and support
199
201
 
200
- If you want your project to be named something else, for example `MyAwesomeProject`, that's no problem! All you have to do is go to _Settings_ at the top right corner of the page, and rename your repository to `MyAwesomeProject` (remember to click on the _Rename_ button to confirm). Then you need to scroll down to the _GitHub Pages_ section and choose "master branch" as the source (not "master branch /docs folder"!).
202
+ Visit the [official FAQ page](https://beautifuljekyll.com/faq) for answers to commonly asked questions.
201
203
 
202
- Now your website will be at `https://<yourusername>.github.io\MyAwesomeProject`.
204
+ Beautiful Jekyll is used by 50,000+ people with wildly varying degrees of web skills, so it's impossible to answer all the questions that may arise. For any question that's not specifically related to Beautiful Jekyll and is more about Jekyll or web development in general, the answer can often be found on Google, in the [Jekyll documentation](https://jekyllrb.com/), or on the [Jekyll support forum](https://talk.jekyllrb.com/).
203
205
 
204
- #### How do I change the number of posts per page OR the colour of the navigation bar OR the image in the navigation bar OR ...?
206
+ To receive support, select one of the [different plans](https://beautifuljekyll.com/plans) Beautiful Jekyll offers.
205
207
 
206
- Beautiful Jekyll is built to be very customizable, and as such, many questions about "how do I change ..." can be answered by looking at the `_config.yml` file. The configuration file has many adjustable parameters to customize your site.
208
+ # Contributions
207
209
 
208
- #### How do I add a favicon to my site?
210
+ Thank you to [all past contributors](https://github.com/daattali/beautiful-jekyll/graphs/contributors). If you find any problems or would like to contribute in any way, feel free to create a pull request/open an issue/send me a message.
209
211
 
210
- Easy! Just place a valid `favicon.ico` in the root directory of your project. And then wait! It can take a while to update.
212
+ You can also contribute by becoming an [official sponsor](https://github.com/sponsors/daattali/sponsorships?tier_id=39856) to help keep Beautiful Jekyll well-maintained.
211
213
 
212
- #### How do I move the blog to another page instead of having it on the home page?
213
-
214
- The default style of Beautiful Jekyll is to feature the blog feed on the front page. But for many sites that's not the ideal structure, and you may want to have a separate dedicated page for the blog posts. To have the blog hosted on a different URL (for example at `<mysite.com>/blog`), copy the `index.html` file into a folder with the same name as the desired page (for example, to `blog/index.html`), and in the `_config.yml` file you need to add a parameter `paginate_path: "/<page name>/page:num/"` (for example `paginate_path: "/blog/page:num/"`).
215
-
216
- #### What size do you recommend using for the `bigimg` photos?
217
-
218
- Unfortunately, this is a no-answer! There isn't a one-size-fits-all solution to this, because every person will view your site on a different browser with different dimensions. Some browsers will have very wide aspect ratio, some will be narrower, some will be vertical (such as phones), different phones have different screens, etc. The image will always be centered, so the only tip I can give is that you should make sure the important part of the image is in the middle so that it'll always show. Other than that, every browser will show a different clipping of the image.
219
-
220
- #### How do I use MathJax equations in my posts?
221
-
222
- MathJax can be easily integrated into your website with a one-line addition. You can see [this discussion](https://github.com/daattali/beautiful-jekyll/issues/195) for more information.
223
-
224
- ## Contributions
225
-
226
- Thank you to [all past contributors](https://github.com/daattali/beautiful-jekyll/graphs/contributors). If you find any problems or would like to contribute in any way, feel free to create a pull request/open an issue/send me a message. Any comments are welcome!
227
-
228
- You can also contribute by becoming an [official sponsor](https://github.com/sponsors/daattali) to help keep beautiful-jekyll well-maintained.
229
-
230
- ## Credits
214
+ # Credits
231
215
 
232
216
  This template was not made *entirely* from scratch. I'd like to give special thanks to [Jekyll Now](https://github.com/barryclark/jekyll-now) and [Bootstrap Clean Blog](https://github.com/IronSummitMedia/startbootstrap-clean-blog), from whom I've taken several ideas initially.
233
217
 
234
218
  I'd also like to thank [Dr. Jekyll's Themes](https://drjekyllthemes.github.io/), [Jekyll Themes](http://jekyllthemes.org/), and another [Jekyll Themes](http://jekyllrc.github.io/jekyllthemes/) for featuring Beautiful Jekyll in their Jekyll theme directories.
235
-
236
- ## Known limitations
237
-
238
- - If there are many navigation bar links and an avatar, some of the links may get partially hidden behind the avatar. I suggest either re-thinking the number of links, or not using an avatar.
@@ -487,7 +487,7 @@ pa: &DEFAULT_PA
487
487
  comment_success_msg : "ਤੁਹਾਡੀਆਂ ਟਿੱਪਣੀਆਂ ਲਈ ਧੰਨਵਾਦ! ਇਹ ਮਨਜ਼ੂਰੀ ਮਿਲਣ ਦੇ ਬਾਅਦ ਸਾਈਟ 'ਤੇ ਦਿਖਾਇਆ ਜਾਵੇਗਾ।"
488
488
  comment_error_msg : "ਮੁਆਫ ਕਰਨਾ, ਤੁਹਾਡੀ ਅਧੀਨਗੀ ਵਿੱਚ ਕੋਈ ਗਲਤੀ ਹੋਈ ਸੀ ਕਿਰਪਾ ਕਰਕੇ ਯਕੀਨੀ ਬਣਾਓ ਕਿ ਸਾਰੇ ਲੋੜੀਂਦੇ ਖੇਤਰ ਪੂਰੇ ਹੋ ਗਏ ਹਨ ਅਤੇ ਦੁਬਾਰਾ ਕੋਸ਼ਿਸ਼ ਕਰੋ।"
489
489
  pa-IN:
490
- <<: *DEFAULT_PA
490
+ <<: *DEFAULT_PA
491
491
 
492
492
  # Another locale
493
493
  # --------------
@@ -1,6 +1,6 @@
1
- {% if page.comments %}
1
+ {% if page.comments %}
2
2
  {% include disqus.html %}
3
3
  {% include fb-comment.html %}
4
4
  {% include staticman-comments.html %}
5
5
  {% include utterances-comment.html %}
6
- {% endif %}
6
+ {% endif %}
@@ -1,19 +1,19 @@
1
1
  {%- if site.disqus -%}
2
2
  <div class="disqus-comments">
3
- <div class="comments">
3
+ <div class="comments">
4
4
  <div id="disqus_thread"></div>
5
5
  <script type="text/javascript">
6
- var disqus_shortname = '{{ site.disqus }}';
7
- /* ensure that pages with query string get the same discussion */
8
- var url_parts = window.location.href.split("?");
9
- var disqus_url = url_parts[0];
10
- (function() {
11
- var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
12
- dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
13
- (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
14
- })();
6
+ var disqus_shortname = '{{ site.disqus }}';
7
+ /* ensure that pages with query string get the same discussion */
8
+ var url_parts = window.location.href.split("?");
9
+ var disqus_url = url_parts[0];
10
+ (function() {
11
+ var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
12
+ dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
13
+ (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
14
+ })();
15
15
  </script>
16
16
  <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
17
- </div>
17
+ </div>
18
18
  </div>
19
19
  {%- endif -%}
@@ -1,7 +1,7 @@
1
1
  {% if include.css.sri %}
2
2
  <link href="{{ include.css.href }}" rel="stylesheet" integrity="{{ include.css.sri }}" crossorigin="anonymous">
3
3
  {% elsif include.css.href %}
4
- <link rel="stylesheet" href="{{ include.css.href }}" />
4
+ <link rel="stylesheet" href="{{ include.css.href }}">
5
5
  {% else %}
6
- <link rel="stylesheet" href="{{ include.css }}" />
6
+ <link rel="stylesheet" href="{{ include.css }}">
7
7
  {% endif %}
@@ -1,14 +1,16 @@
1
1
  {%- if site.fb_comment_id -%}
2
2
  <div class="comments">
3
- <div id="fb-root"></div>
4
- <script>(function(d, s, id) {
5
- var js, fjs = d.getElementsByTagName(s)[0];
6
- if (d.getElementById(id)) return;
7
- js = d.createElement(s); js.id = id;
8
- js.src = 'https://connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.12&appId={{ site.fb_comment_id }}&autoLogAppEvents=1';
9
- fjs.parentNode.insertBefore(js, fjs);
10
- }(document, 'script', 'facebook-jssdk'));</script>
11
- <div class="fb-comments" data-href="{{ page.url | absolute_url }}" data-width="100%" data-numposts="5"></div>
12
- <noscript>Please enable JavaScript to view the comments powered by Facebook.</noscript>
3
+ <div id="fb-root"></div>
4
+ <script>
5
+ (function(d, s, id) {
6
+ var js, fjs = d.getElementsByTagName(s)[0];
7
+ if (d.getElementById(id)) return;
8
+ js = d.createElement(s); js.id = id;
9
+ js.src = 'https://connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.12&appId={{ site.fb_comment_id }}&autoLogAppEvents=1';
10
+ fjs.parentNode.insertBefore(js, fjs);
11
+ }(document, 'script', 'facebook-jssdk'));
12
+ </script>
13
+ <div class="fb-comments" data-href="{{ page.url | absolute_url }}" data-width="100%" data-numposts="5"></div>
14
+ <noscript>Please enable JavaScript to view the comments powered by Facebook.</noscript>
13
15
  </div>
14
16
  {%- endif -%}