beautiful-jekyll-theme 4.1.0 → 5.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4d8b59dc9b92ac72d4fb06b368d9ed8bf85eb660b02d2b488b2cd0ec5dc6e523
4
- data.tar.gz: 62db8a1cdb5fb75bdbb0bffeb381298df5121a3af0b8b710b017088b77bb27e6
3
+ metadata.gz: f39224015daeee1419c359a845eadddc54f33e5829aa71e5b4519b209f27bf94
4
+ data.tar.gz: ddd575749dcb0a980570c42296de37f3a60de01bcbeeb56456819426479840d8
5
5
  SHA512:
6
- metadata.gz: 8aba279446b8aa539d9419ada18f91ab42e33fba348678c2aa40770a4249625250cf3fc293c3b683f10d1c666b559a359d5a9a882aa2d0965952d2fffbed1cac
7
- data.tar.gz: 85802295e3b5c95a2405758fba3dd2029a300dfb2a851ec8868a634cde067edb86ef4d6244160340f7eb74e583a4b781a76e72d3f9256c402fda25bdd32cacef
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,52 +1,51 @@
1
- [![](https://i.imgur.com/zNBkzj1.png)](https://xscode.com/daattali/beautiful-jekyll)
1
+ [![](https://i.imgur.com/zNBkzj1.png)](https://beautifuljekyll.com/plans/)
2
2
 
3
3
  # Beautiful Jekyll
4
4
 
5
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)
6
6
  [![Gem Version](https://badge.fury.io/rb/beautiful-jekyll-theme.svg)](https://badge.fury.io/rb/beautiful-jekyll-theme)
7
7
 
8
- > *Created by [Dean Attali](https://deanattali.com)* &middot; [Demo](https://beautifuljekyll.com/)
8
+ > By [Dean Attali](https://deanattali.com) &middot; [Demo](https://beautifuljekyll.com/)
9
9
 
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) to see it in use, or see examples of websites other people created using this theme [below](#showcased-users-success-stories).
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
- **If you enjoy this theme, please consider [supporting me](https://github.com/sponsors/daattali) for developing and maintaining it for over 5 years.**
13
-
14
- <p align="center">
15
- <a style="display: inline-block;" href="https://github.com/sponsors/daattali">
16
- <img height="40" src="https://i.imgur.com/034B8vq.png" />
17
- </a>
18
- &nbsp;&nbsp;
19
- <a style="display: inline-block;" href="https://paypal.me/daattali">
20
- <img height="40" src="https://camo.githubusercontent.com/0e9e5cac101f7093336b4589c380ab5dcfdcbab0/68747470733a2f2f63646e2e6a7364656c6976722e6e65742f67682f74776f6c66736f6e2f70617970616c2d6769746875622d627574746f6e40312e302e302f646973742f627574746f6e2e737667" />
21
- </a>
22
- </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!) ❤**
23
13
 
24
14
  ## Table of contents
25
15
 
26
16
  - [Features](#features)
17
+ - [Sponsors 🏆](#sponsors)
27
18
  - [**Build your website in 3 steps**](#build-your-website-in-3-steps)
19
+ - [Plans](#plans)
28
20
  - [Add your own content](#add-your-own-content)
29
21
  - [Customizing parameters for each page](#customizing-parameters-for-each-page)
30
22
  - [Supported parameters](#supported-parameters)
31
- - [Showcased users (success stories!)](#showcased-users-success-stories)
23
+ - [Featured users (success stories!)](#featured-users-success-stories)
32
24
  - [FAQ and support](#faq-and-support)
33
25
  - [Credits and contributions](#credits)
34
26
 
35
27
  # Features
36
28
 
29
+ Check out [*What's New?*](https://beautifuljekyll.com/updates/) to see the latest features.
30
+
37
31
  - **SIMPLE**: The primary goal of Beautiful Jekyll is to allow literally *anyone* to create a website in a few minutes.
38
- - **Modern**: Uses the latest best practices and technologies to achieve nearly perfect scores on Google Chrome's Audit.
39
- - **Mobile-first**: Designed to look great on both large-screen and small-screen (mobile) devices.
40
- - **Highly customizable**: Many personalization settings such as changing the background colour/image, adding a logo.
41
- - **Flexible usage**: Use Beautiful Jekyll directly on GitHub or using a Ruby gem - choose the best [development method](#build-your-website-in-3-steps) for you.
42
- - **Battle-tested**: By using Beautiful Jekyll, you'll be joining tens of thousands of users who used this theme since 2015.
43
- - **Links to your social media**: You can easily add links to any of your social media accounts in the footer of every page.
44
- - **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).
45
- - **Share 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).
46
39
  - **Tags**: Any blog post can be tagged with keywords, and an index page showing all the tags is automatically generated.
47
- - **Tracking analytics**: Easily integrate Google Analytics, or other analytics platforms, to track visits to your website.
48
- - **Photos support**: Any page can have a cover photo around its title, and any blog post can have an associated image.
49
- - **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)
50
49
 
51
50
  # Build your website in 3 steps
52
51
 
@@ -66,45 +65,51 @@ Fork this project by clicking the __*Fork*__ button at the top right corner of t
66
65
 
67
66
  ### 2. Rename the project to `<yourusername>.github.io`
68
67
 
69
- 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.
70
69
 
71
70
  ### 3. Customize your website settings
72
71
 
73
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.
74
73
 
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!**
75
+
75
76
  ### 4. Congratulations! You have a website!
76
77
 
77
- 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.
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.
78
79
 
79
- 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 :)**
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.
80
81
 
81
82
  ## The hard way (using ruby gems)
82
83
 
83
- 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).
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.
85
+
86
+ # Plans
84
87
 
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).
85
89
 
86
90
  # Add your own content
87
91
 
88
- 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). You can look at some files on this demo site to get an idea of how to write markdown.
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).
89
93
 
90
- 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 code that generated the pretty text. Very easy!
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!
91
95
 
92
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.
93
97
 
94
- 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`.
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`.
95
99
 
96
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.
97
101
 
98
102
  # Customizing parameters for each page
99
103
 
100
- **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**. 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-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:
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**:
105
+
101
106
 
102
107
  ```
103
108
  ---
104
109
  ---
105
110
  ```
106
111
 
107
- 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:
108
113
 
109
114
  ```
110
115
  ---
@@ -113,15 +118,15 @@ subtitle: Here you'll find all the ways to get in touch with me
113
118
  ---
114
119
  ```
115
120
 
116
- You can look at the top of [`aboutme.md`](https://raw.githubusercontent.com/daattali/beautiful-jekyll/master/aboutme.md) as an example.
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.
117
122
 
118
- **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.**
123
+ You can look at the top of [`aboutme.md`](https://raw.githubusercontent.com/daattali/beautiful-jekyll/master/aboutme.md) as an example.
119
124
 
120
- If you don't include YAML then your file will not use this template.
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.**
121
126
 
122
127
  # Supported parameters
123
128
 
124
- 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 settings.
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.
125
130
 
126
131
  ## Main parameters
127
132
 
@@ -133,7 +138,18 @@ title | Page or blog post title
133
138
  subtitle | Short description of page or blog post that goes under the title
134
139
  tags | List of tags to categorize the post. Separate the tags with commas and place them inside square brackets. Example: `[personal, analysis, finance]`
135
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"}`.
136
- 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`.
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.
137
153
 
138
154
  ## Less commonly used parameters
139
155
 
@@ -143,14 +159,12 @@ Parameter | Description
143
159
  ----------- | -----------
144
160
  readtime | If you want a post to show how many minutes it will take to read it, use `readtime: true`.
145
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`.
146
- thumbnail-img | For blog posts, if you want to add a thumbnail that'll show up next to the post's excerpt 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.
147
- share-img | The image to use when sharing the page to social media. If not provided, then `cover-img` or `thumbnail-img` will be used.
148
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`.
149
- 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`
150
- 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.
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.
151
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.
152
- 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.
153
- description | A brief description of the page (used in search engines and when the page is shared).
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.
154
168
 
155
169
  ## Advanced parameters
156
170
 
@@ -158,9 +172,12 @@ These are advanced parameters that are only useful for people who need very fine
158
172
 
159
173
  Parameter | Description
160
174
  ----------- | -----------
161
- 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`)
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.
162
179
  language | HTML language code to be set on the page's &lt;html&gt; element.
163
- use-site-title | If you want to use the site title rather than the page title as the HTML document title, use `use-site-title: true`.
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.
164
181
  js | List of local JavaScript files to include in the page (eg. `/assets/js/mypage.js`)
165
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="`
166
183
  css | List of local CSS files to include in the page
@@ -174,96 +191,28 @@ ext-css | List of external CSS files to include in the page. External CSS f
174
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.
175
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!
176
193
 
177
- # Showcased users (success stories!)
178
-
179
- Beautiful Jekyll has been used in tens of thousands of websites since 2015. Here is a sample of some websites that use Beautiful Jekyll. If you'd like to showcase yourself and join this list, any level of [sponsorship](https://github.com/sponsors/daattali) will grant you that perk!
180
-
181
- ## Project/company websites
182
-
183
- | Website | Description |
184
- | :------ |:----------- |
185
- | [repidemicsconsortium.org/](https://www.repidemicsconsortium.org/) | R Epidemics Consortium |
186
- | [vaccineimpact.org](https://www.vaccineimpact.org/) | Vaccine Impact Modelling Consortium |
187
- | [derekogle.com/fishR](http://derekogle.com/fishR/) | Using R for Fisheries Analyses |
188
- | [joecks.github.io/clipboard-actions](http://joecks.github.io/clipboard-actions/) | Clipboard Actions - an Android app |
189
- | [deanattali.com/shinyjs](http://deanattali.com/shinyjs/) | shinyjs - an R package |
190
- | [blabel.github.io](http://blabel.github.io) | Library for canonicalising blank node labels in RDF graphs |
191
- | [reactionic.github.io](http://reactionic.github.io) | Create iOS and Android apps with React and Ionic |
192
- | [ja2-stracciatella.github.io](http://ja2-stracciatella.github.io) | Jagged Alliance 2 Stracciatella |
193
- | [ddocent.com](http://ddocent.com/) | RADSeq Bioinformatics and Beyond |
194
- | [guitarlessons.org](https://www.guitarlessons.org/) | Free online guitar lessons for all |
195
- | [terremotocentroitalia.info](https://www.terremotocentroitalia.info/) | Information about the 2016 Italy earthquake |
196
-
197
-
198
- ## Personal websites
199
-
200
- | Website | Who | What |
201
- | :------ |:--- | :--- |
202
- | [deanattali.com](https://deanattali.com) | Dean Attali | Creator of Beautiful Jekyll |
203
- | [ouzor.github.io](http://ouzor.github.io) | Juuso Parkkinen | Data scientist |
204
- | [derekogle.com](http://derekogle.com/) | Derek Ogle | Professor of Mathematical Sciences and Natural Resources |
205
- | [melyanna.github.io](http://melyanna.github.io/) | Melyanna | Shows off her nice art |
206
- | [chauff.github.io](http://chauff.github.io/) | Claudia Hauff | Professor at Delft University of Technology |
207
- | [kootenpv.github.io](http://kootenpv.github.io/) | Pascal van Kooten | Data analytics |
208
- | [sjackman.ca](http://sjackman.ca) | Shaun Jackman | PhD candidate in bioinformatics |
209
- | [anudit.in](http://www.anudit.in/) | Anudit Verma | Engineering student |
210
- | [sharepointoscar.github.io](http://sharepointoscar.github.io) | Oscar Medina | Independent Hacker |
211
- | [ocram85.com](https://ocram85.com) | Marco Blessing | A personal blog about PowerShell and automation |
212
- | [khanna.cc](https://khanna.cc/) | Harry Khanna | Law and software |
213
-
214
- # FAQ and support
215
-
216
- If you need any help, I suggest heading over to the [Jekyll support forum](https://talk.jekyllrb.com/).
217
-
218
- 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.
219
-
220
- **If you really wany my personal help, please visit https://xscode.com/daattali/beautiful-jekyll to hire my services.**
221
-
222
- - ### How do I add a favicon to my site?
223
-
224
- Easy! Just place a valid `favicon.ico` in the root directory of your project. And then wait! It can take a while to update.
225
-
226
- - ### 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 ...?
227
-
228
- 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.
229
-
230
- - ### What if I want to use a custom domain for my site?
231
-
232
- GitHub lets you have your website for free using their `github.io` domain. If you want your own domain (such as `https://myname.com`), it's easy and will cost about $10-$15 per year. First you need to buy a domain name (I recommend [Namecheap](https://namecheap.pxf.io/daattali)) and then follow the [instructions GitHub provides](https://docs.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site).
194
+ # Featured users (success stories!)
233
195
 
234
- - ### What if I want a free domain, but not `https://<yourusername>.github.io`?
196
+ Visit the [Official website](http://beautifuljekyll.com/examples) to see sample websites using Beautiful Jekyll.
235
197
 
236
- 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`.
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!
237
199
 
238
- 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"!).
239
-
240
- Now your website will be at `https://<yourusername>.github.io\MyAwesomeProject`.
241
-
242
- - ### How do I move the blog to another page instead of having it on the home page?
243
-
244
- The default style of Beautiful Jekyll is to feature the blog feed on the front page. For some 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/"`).
245
-
246
- - ### What size do you recommend using for the `cover-img` photos?
200
+ # FAQ and support
247
201
 
248
- 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.
202
+ Visit the [official FAQ page](https://beautifuljekyll.com/faq) for answers to commonly asked questions.
249
203
 
250
- - ### How do I use math equations in my posts?
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/).
251
205
 
252
- 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.
206
+ To receive support, select one of the [different plans](https://beautifuljekyll.com/plans) Beautiful Jekyll offers.
253
207
 
254
208
  # Contributions
255
209
 
256
- 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!
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.
257
211
 
258
- You can also contribute by becoming an [official sponsor](https://github.com/sponsors/daattali) to help keep beautiful-jekyll well-maintained.
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.
259
213
 
260
214
  # Credits
261
215
 
262
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.
263
217
 
264
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.
265
-
266
- # Known limitations
267
-
268
- - 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.
269
-
@@ -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 %}
@@ -19,6 +19,12 @@
19
19
  {% endfor %}
20
20
  {% endif %}
21
21
 
22
+ {% if site.site-js %}
23
+ {% for js in site.site-js %}
24
+ <script src="{{ js | relative_url }}"></script>
25
+ {% endfor %}
26
+ {% endif %}
27
+
22
28
  {% if page.ext-js %}
23
29
  {% for js in page.ext-js %}
24
30
  {% include ext-js.html js=js %}
@@ -5,7 +5,9 @@
5
5
  {% include social-networks-links.html %}
6
6
  {% if page.footer-extra %}
7
7
  <div class="footer-custom-content">
8
- {% include {{ page.footer-extra }} %}
8
+ {% for file in page.footer-extra %}
9
+ {% include {{ file }} %}
10
+ {% endfor %}
9
11
  </div>
10
12
  {% endif %}
11
13
  <p class="copyright text-muted">
@@ -17,7 +19,9 @@
17
19
 
18
20
  {% if site.url-pretty %}
19
21
  &nbsp;&bull;&nbsp;
20
- <a href="{{ '' | absolute_url }}">{{ site.url-pretty }}</a>
22
+ <span class="author-site">
23
+ <a href="{% if site.url-canonical %}{{ site.url-canonical }}{% else %}{{ '' | absolute_url }}{% endif %}">{{ site.url-pretty }}</a>
24
+ </span>
21
25
  {% endif %}
22
26
 
23
27
  {% if site.matomo %}
@@ -28,10 +32,10 @@
28
32
  {% endif%}
29
33
  </p>
30
34
  <!-- Please don't remove this, keep my open source work credited :) -->
31
- <p class="theme-by text-muted">
32
- Theme by
33
- <a href="https://beautifuljekyll.com">beautiful-jekyll</a>
34
- </p>
35
+ {% unless site.remove-ads %}<p class="theme-by text-muted">
36
+ Powered by
37
+ <a href="https://beautifuljekyll.com">Beautiful Jekyll</a>
38
+ </p>{% endunless %}
35
39
  </div>
36
40
  </div>
37
41
  </div>
@@ -2,17 +2,34 @@
2
2
  <meta charset="utf-8">
3
3
  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
4
4
 
5
- <title>{% if page.use-site-title %}{{ site.title }} {{ site.title-separator | default: '-' }} {{ site.description }}{% elsif page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
5
+ {% capture title %}
6
+ {%- if page.share-title -%}
7
+ {{ page.share-title }}
8
+ {%- elsif page.title -%}
9
+ {{ page.title }}
10
+ {%- else -%}
11
+ {{ site.title }}
12
+ {%- endif -%}
13
+ {% endcapture %}
14
+
15
+ {% capture description %}
16
+ {%- if page.share-description -%}
17
+ {{ page.share-description }}
18
+ {%- elsif page.subtitle -%}
19
+ {{ page.subtitle }}
20
+ {%- else -%}
21
+ {%- assign excerpt_length = site.excerpt_length | default: 50 -%}
22
+ {{ page.content | strip_html | xml_escape | truncatewords: excerpt_length | strip }}
23
+ {%- endif -%}
24
+ {% endcapture %}
25
+
26
+ <title>{{ title }}</title>
6
27
 
7
28
  {% if site.author %}
8
29
  <meta name="author" content="{{ site.author }}">
9
30
  {% endif %}
10
31
 
11
- {% if page.description %}
12
- <meta name="description" content="{{ page.description }}">
13
- {% elsif page.subtitle %}
14
- <meta name="description" content="{{ page.subtitle }}">
15
- {% endif %}
32
+ <meta name="description" content="{{ description }}">
16
33
 
17
34
  {% if site.mobile-theme-col %}
18
35
  <meta name="theme-color" content="{{ site.mobile-theme-col }}">
@@ -22,7 +39,7 @@
22
39
  <meta name="keywords" content="{{ site.keywords }}">
23
40
  {% endif %}
24
41
 
25
- <link rel="alternate" type="application/rss+xml" title="{{ site.title | default: 'Untitled' }} {{ site.title-separator | default: '-' }} {{ site.description }}" href="{{ '/feed.xml' | absolute_url }}">
42
+ <link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ '/feed.xml' | absolute_url }}">
26
43
 
27
44
  {% include gtag.html %}
28
45
  {% include gtm_head.html %}
@@ -40,25 +57,24 @@
40
57
  {% endfor %}
41
58
  {% endif %}
42
59
 
60
+ {% if site.site-css %}
61
+ {% for css in site.site-css %}
62
+ <link rel="stylesheet" href="{{ css | relative_url }}">
63
+ {% endfor %}
64
+ {% endif %}
65
+
43
66
  {% if page.ext-css %}
44
67
  {% for css in page.ext-css %}
45
68
  {% include ext-css.html css=css %}
46
69
  {% endfor %}
47
70
  {% endif %}
48
-
71
+
49
72
  {% if page.css %}
50
73
  {% for css in page.css %}
51
74
  <link rel="stylesheet" href="{{ css | relative_url }}">
52
75
  {% endfor %}
53
76
  {% endif %}
54
77
 
55
- {% if site.site-css %}
56
- {% for css in site.site-css %}
57
- <link rel="stylesheet" href="{{ css | relative_url }}">
58
- {% endfor %}
59
- {% endif %}
60
-
61
- <!-- Facebook OpenGraph tags -->
62
78
  {% if site.fb_app_id %}
63
79
  <meta property="fb:app_id" content="{{ site.fb_app_id }}">
64
80
  {% endif %}
@@ -67,63 +83,43 @@
67
83
  <meta property="og:site_name" content="{{ site.title }}">
68
84
  {% endif %}
69
85
 
70
- {% if page.meta-title %}
71
- <meta property="og:title" content="{{ page.meta-title }}">
72
- {% elsif page.title %}
73
- <meta property="og:title" content="{{ page.title }}">
74
- {% elsif site.title %}
75
- <meta property="og:title" content="{{ site.title }}">
76
- {% endif %}
86
+ {%- capture img -%}
87
+ {%- if page.share-img -%}
88
+ {{ page.share-img }}
89
+ {%- elsif page.cover-img -%}
90
+ {%- if page.cover-img.first -%}
91
+ {{ page.cover-img[0].first.first }}
92
+ {%- else -%}
93
+ {{ page.cover-img }}
94
+ {%- endif -%}
95
+ {%- elsif page.thumbnail-img -%}
96
+ {{ page.thumbnail-img }}
97
+ {%- elsif site.avatar -%}
98
+ {{ site.avatar }}
99
+ {% endif %}
100
+ {%- endcapture -%}
101
+ {%- assign img=img | strip -%}
77
102
 
78
- {% if page.meta-description %}
79
- <meta property="og:description" content="{{ page.meta-description }}">
80
- {% elsif page.subtitle %}
81
- <meta property="og:description" content="{{ page.subtitle }}">
82
- {% else %}
83
- <meta property="og:description" content="{{ page.content | strip_html | xml_escape | truncatewords: 50 }}">
84
- {% endif %}
103
+ <meta property="og:title" content="{{ title }}">
104
+ <meta property="og:description" content="{{ description }}">
85
105
 
106
+ {% if img != "" %}
107
+ <meta property="og:image" content="{{ img | absolute_url }}">
108
+ {% endif %}
86
109
 
87
110
  {% if page.id %}
88
111
  <meta property="og:type" content="article">
89
112
  <meta property="og:article:author" content="{{ site.author }}">
90
113
  <meta property="og:article:published_time" content="{{ page.date | date_to_xmlschema }}">
91
- {% else %}
92
- <meta property="og:type" content="website">
93
- {% endif %}
94
-
95
- {% if page.id %}
96
114
  <meta property="og:url" content="{{ page.url | absolute_url }}">
97
115
  <link rel="canonical" href="{{ page.url | absolute_url }}">
98
116
  {% else %}
117
+ <meta property="og:type" content="website">
99
118
  <meta property="og:url" content="{{ page.url | absolute_url | strip_index }}">
100
119
  <link rel="canonical" href="{{ page.url | absolute_url | strip_index }}">
101
120
  {% endif %}
102
121
 
103
- {%- capture shareimg -%}
104
- {% if page.share-img %}
105
- {{ page.share-img }}
106
- {% elsif page.cover-img %}
107
- {% if page.cover-img.first %}
108
- {{ page.cover-img[0].first.first }}
109
- {% else %}
110
- {{ page.cover-img }}
111
- {% endif %}
112
- {% elsif page.thumbnail-img %}
113
- {{ page.thumbnail-img }}
114
- {% elsif site.avatar %}
115
- {{ site.avatar }}
116
- {% endif %}
117
- {% endcapture %}
118
- {% assign shareimg=shareimg | strip %}
119
-
120
- {% if shareimg != "" %}
121
- <meta property="og:image" content="{{ shareimg | absolute_url }}">
122
- {% endif %}
123
-
124
-
125
- <!-- Twitter summary cards -->
126
- {% if shareimg != "" and shareimg != site.avatar %}
122
+ {% if img != "" and img != site.avatar %}
127
123
  <meta name="twitter:card" content="summary_large_image">
128
124
  {% else %}
129
125
  <meta name="twitter:card" content="summary">
@@ -131,33 +127,23 @@
131
127
  <meta name="twitter:site" content="@{{ site.social-network-links.twitter }}">
132
128
  <meta name="twitter:creator" content="@{{ site.social-network-links.twitter }}">
133
129
 
134
- {% if page.meta-title %}
135
- <meta name="twitter:title" content="{{ page.meta-title }}">
136
- {% elsif page.title %}
137
- <meta name="twitter:title" content="{{ page.title }}">
138
- {% else %}
139
- <meta name="twitter:title" content="{{ site.title }}">
140
- {% endif %}
130
+ <meta property="twitter:title" content="{{ title }}">
131
+ <meta property="twitter:description" content="{{ description }}">
141
132
 
142
- {% if page.meta-description %}
143
- <meta name="twitter:description" content="{{ page.meta-description }}">
144
- {% elsif page.subtitle %}
145
- <meta name="twitter:description" content="{{ page.subtitle }}">
146
- {% else %}
147
- <meta name="twitter:description" content="{{ page.content | strip_html | xml_escape | truncatewords: 50 }}">
133
+ {% if img != "" %}
134
+ <meta name="twitter:image" content="{{ img | absolute_url }}">
148
135
  {% endif %}
149
136
 
150
- {% if shareimg != "" %}
151
- <meta name="twitter:image" content="{{ shareimg | absolute_url }}">
152
- {% endif %}
153
-
154
- {% if site.matomo %}
155
137
  {% include matomo.html %}
156
- {% endif %}
157
138
 
158
139
  {% if page.comments and site.staticman.repository and site.staticman.branch %}
159
- <!-- Staticman -->
160
140
  <link rel="stylesheet" href="{{ "/assets/css/staticman.css" | relative_url }}">
161
141
  {% endif %}
162
142
 
143
+ {% if page.head-extra %}
144
+ {% for file in page.head-extra %}
145
+ {% include {{ file }} %}
146
+ {% endfor %}
147
+ {% endif %}
148
+
163
149
  </head>