beautiful-jekyll-theme 4.1.0 → 6.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/404.html +1 -1
- data/LICENSE +1 -1
- data/README.md +96 -132
- data/_data/ui-text.yml +1 -1
- data/_includes/cloudflare_analytics.html +8 -0
- data/_includes/commentbox.html +7 -0
- data/_includes/comments.html +4 -2
- data/_includes/footer-scripts.html +6 -0
- data/_includes/footer.html +16 -7
- data/_includes/giscus-comment.html +16 -0
- data/_includes/google_analytics.html +12 -0
- data/_includes/head.html +67 -78
- data/_includes/header.html +42 -30
- data/_includes/nav.html +21 -5
- data/_includes/readtime.html +2 -2
- data/_includes/search.html +39 -0
- data/_includes/social-networks-links.html +81 -5
- data/_includes/social-share.html +9 -1
- data/_includes/staticman-comments.html +1 -1
- data/_includes/utterances-comment.html +1 -1
- data/_layouts/base.html +16 -16
- data/_layouts/default.html +17 -1
- data/_layouts/home.html +60 -35
- data/_layouts/minimal.html +20 -4
- data/_layouts/page.html +19 -2
- data/_layouts/post.html +21 -9
- data/assets/css/{main-minimal.css → beautifuljekyll-minimal.css} +1 -1
- data/assets/css/{main.css → beautifuljekyll.css} +334 -142
- data/assets/img/install-steps.gif +0 -0
- data/assets/js/{main.js → beautifuljekyll.js} +57 -14
- data/assets/js/staticman.js +39 -28
- data/feed.xml +6 -5
- data/staticman.yml +1 -1
- data/tags.html +1 -1
- metadata +43 -12
- data/assets/js/jquery-3.4.1.min.js +0 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e5f94bcc1c22117a38d676a5e28f66de694b6035d96a7b3dc8e21f892516679b
|
4
|
+
data.tar.gz: be0b2f40ea6dc3c7a8ba5194d3c6d4dd34aafe547e03614ed5b950a1c85f84cb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4fb70da2d2c5aca764363650df5e0e95f45e3bb3684e926dcca4ada7b84045dc9fac68b964f0e8b2b35e221a27305103ff9f2ac8cab6632a1c9b9c44d4670b34
|
7
|
+
data.tar.gz: 7d18e60a8d21f3bbd6f078a4baeff14e2e2b71210bb2557b34fba2983c37eab8006fffe430eee69c5f5829d78e7500a0361e667a5da09623f37407b00ac8e014
|
data/404.html
CHANGED
data/LICENSE
CHANGED
data/README.md
CHANGED
@@ -1,110 +1,121 @@
|
|
1
|
-
[![](https://i.imgur.com/zNBkzj1.png)](https://xscode.com/daattali/beautiful-jekyll)
|
2
|
-
|
3
1
|
# Beautiful Jekyll
|
4
2
|
|
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
3
|
[![Gem Version](https://badge.fury.io/rb/beautiful-jekyll-theme.svg)](https://badge.fury.io/rb/beautiful-jekyll-theme)
|
7
4
|
|
8
|
-
>
|
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).
|
5
|
+
> By [Dean Attali](https://deanattali.com) · [Demo](https://beautifuljekyll.com/)
|
11
6
|
|
12
|
-
**
|
7
|
+
**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.
|
13
8
|
|
14
|
-
|
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
|
-
|
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>
|
9
|
+
**If you enjoy Beautiful Jekyll, please consider [supporting me](https://github.com/sponsors/daattali). You'll also gain access to office hours and more rewards! ❤**
|
23
10
|
|
24
11
|
## Table of contents
|
25
12
|
|
26
13
|
- [Features](#features)
|
14
|
+
- [Sponsors 🏆](#sponsors)
|
27
15
|
- [**Build your website in 3 steps**](#build-your-website-in-3-steps)
|
16
|
+
- [Plans](#plans)
|
28
17
|
- [Add your own content](#add-your-own-content)
|
29
18
|
- [Customizing parameters for each page](#customizing-parameters-for-each-page)
|
30
19
|
- [Supported parameters](#supported-parameters)
|
31
|
-
- [
|
32
|
-
- [
|
33
|
-
- [
|
20
|
+
- [Featured users (success stories!)](#featured-users-success-stories)
|
21
|
+
- [Next steps](#next-steps)
|
22
|
+
- [Getting help](#getting-help)
|
23
|
+
- [Credits and contributions](#contributions)
|
34
24
|
|
35
25
|
# Features
|
36
26
|
|
27
|
+
__Check out [*What's New?*](https://beautifuljekyll.com/updates/) to see the latest features!__
|
28
|
+
|
37
29
|
- **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
|
42
|
-
- **Battle-tested**:
|
43
|
-
- **
|
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/),
|
45
|
-
- **
|
46
|
-
- **
|
47
|
-
- **
|
48
|
-
- **Photos support**: Any page can have a cover photo
|
49
|
-
- **
|
30
|
+
- **Modern**: Uses the latest best practices and technologies to achieve nearly perfect scores on Google Chrome's Audit.
|
31
|
+
- **Mobile-first**: Designed to look great on both large-screen and small-screen (mobile) devices.
|
32
|
+
- **Highly customizable**: Many personalization settings such as changing the background colour/image, adding a logo.
|
33
|
+
- **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.
|
34
|
+
- **Battle-tested**: By using Beautiful Jekyll, you'll be joining 50,000+ users enjoying this theme since 2015.
|
35
|
+
- **SEO and social media support**: Customize how your site looks on Google and when shared on social media.
|
36
|
+
- **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/), [Staticman](https://staticman.net), [giscus](https://giscus.app), or [CommentBox](https://commentbox.io/).
|
37
|
+
- **Tags**: Any blog post can be tagged with keywords, and an index page is automatically generated.
|
38
|
+
- **Analytics**: Easily integrate Google Analytics, or other analytics platforms, to track visits to your website.
|
39
|
+
- **Search**: Let users easily find any page using a Search button in the navigation bar.
|
40
|
+
- **Photos support**: Any page can have a full-width cover photo and thumbnail.
|
41
|
+
- **RSS**: An RSS feed is automatically created, so you can even host a podcast easily with Beautiful Jekyll.
|
42
|
+
|
43
|
+
<h2 id="sponsors">Sponsors 🏆</h2>
|
44
|
+
|
45
|
+
Developing and maintaining Beautiful Jekyll takes a lot of time and effort - thank you to anyone who helps fund this effort!
|
46
|
+
|
47
|
+
- [DoFollow](https://dofollow.co.uk/)
|
48
|
+
- [\_hyp3ri0n](https://hyperiongray.com)
|
49
|
+
|
50
|
+
**[Become a sponsor for Beautiful Jekyll and unlock special rewards\!](https://github.com/sponsors/daattali/sponsorships?tier_id=39856)**
|
50
51
|
|
51
52
|
# Build your website in 3 steps
|
52
53
|
|
53
|
-
There
|
54
|
+
There are a few different ways to build a website using Beautiful Jekyll, and this document will go through the simplest one: using a fork on GitHub. For most people (including myself!), this easy method is the recommended one.
|
55
|
+
|
56
|
+
Even if you choose to use one of the [advanced installation methods](https://beautifuljekyll.com/getstarted/#install-steps-hard), I still suggest you read through the easy method first.
|
54
57
|
|
55
58
|
## The easy way (recommended!)
|
56
59
|
|
57
60
|
Getting started is *literally* as easy as 1-2-3 :smile:
|
58
61
|
|
59
|
-
Scroll down to see the steps involved, but here is a
|
62
|
+
Scroll down to see the steps involved, but here is a 30-second video just as a reference as you work through the steps. If you don't already have a [GitHub account](https://github.com), you'll need to sign up.
|
60
63
|
|
61
64
|
![Installation steps](assets/img/install-steps.gif)
|
62
65
|
|
63
66
|
### 1. Fork this project
|
64
67
|
|
65
|
-
|
68
|
+
Click on the __*Fork*__ button at the top right corner of this page. Forking means that you're copying this entire project and all its files into your account. Do not click on the __*Create fork*__ button on the next page yet.
|
66
69
|
|
67
|
-
### 2. Rename the
|
70
|
+
### 2. Rename the repository to `YOURUSERNAME.github.io`
|
68
71
|
|
69
|
-
|
72
|
+
You'll see the word "repository" used a lot in GitHub - it simply means "project". Under __*Repository name*__ you should see the name `beautiful-jekyll`, this is where you need to rename your project to `YOURUSERNAME.github.io` (replace `YOURUSERNAME` with your GitHub user name). It's important to use this exact name so that GitHub will recognize it and automatically create a website for this project.
|
70
73
|
|
74
|
+
> Tip: If you want to use a different URL for your website, check out the [FAQ](https://beautifuljekyll.com/faq/#custom-domain)
|
75
|
+
|
71
76
|
### 3. Customize your website settings
|
72
77
|
|
73
|
-
Edit the `_config.yml` file to change any settings you want. To edit the file, click on it to view the file and
|
78
|
+
Edit the `_config.yml` file to change any settings you want. To edit the file, first click on it to view the file, and on the next page 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 there are 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. After changing the settings, click the green __*Commit changes*__ button to save these edits.
|
79
|
+
|
80
|
+
> Note: In the video above, only one setting in the `_config.yml` file is edited, but you should go through the rest of the settings as well.
|
74
81
|
|
75
82
|
### 4. Congratulations! You have a website!
|
76
83
|
|
77
|
-
|
84
|
+
If you named your project correctly and made an edit to the config file, 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
85
|
|
79
|
-
|
86
|
+
## The harder way (for advanced users)
|
80
87
|
|
81
|
-
|
88
|
+
The instructions above explain how to use Beautiful Jekyll in the easiest way: by forking on GitHub. There are more [advanced installation methods](https://beautifuljekyll.com/getstarted/#install-steps-hard) that include either using GitHub Pages with remote themes, or using Ruby gems. They provide you with more control, but are only intended for advanced users.
|
82
89
|
|
83
|
-
|
90
|
+
> Note: Beautiful Jekyll was primarily designed to be used as a GitHub theme, so you will not get any support if you use this theme via Ruby gems.
|
84
91
|
|
92
|
+
# Plans
|
93
|
+
|
94
|
+
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, access office hours, or simply support the development efforts, [check out the different plans](https://beautifuljekyll.com/plans).
|
85
95
|
|
86
96
|
# Add your own content
|
87
97
|
|
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
|
98
|
+
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 that's the recommended approach ([here's a great tutorial](https://markdowntutorial.com/) if you need to learn markdown in 5 minutes).
|
89
99
|
|
90
|
-
To
|
100
|
+
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
101
|
|
92
102
|
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
103
|
|
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`.
|
104
|
+
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
105
|
|
96
106
|
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
107
|
|
98
108
|
# Customizing parameters for each page
|
99
109
|
|
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
|
110
|
+
**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**:
|
111
|
+
|
101
112
|
|
102
113
|
```
|
103
114
|
---
|
104
115
|
---
|
105
116
|
```
|
106
117
|
|
107
|
-
|
118
|
+
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
119
|
|
109
120
|
```
|
110
121
|
---
|
@@ -113,15 +124,15 @@ subtitle: Here you'll find all the ways to get in touch with me
|
|
113
124
|
---
|
114
125
|
```
|
115
126
|
|
116
|
-
|
127
|
+
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
128
|
|
118
|
-
|
129
|
+
You can look at the top of [`aboutme.md`](https://raw.githubusercontent.com/daattali/beautiful-jekyll/master/aboutme.md) as an example.
|
119
130
|
|
120
|
-
|
131
|
+
**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
132
|
|
122
133
|
# Supported parameters
|
123
134
|
|
124
|
-
Below is a list of the parameters that
|
135
|
+
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
136
|
|
126
137
|
## Main parameters
|
127
138
|
|
@@ -132,8 +143,19 @@ Parameter | Description
|
|
132
143
|
title | Page or blog post title
|
133
144
|
subtitle | Short description of page or blog post that goes under the title
|
134
145
|
tags | List of tags to categorize the post. Separate the tags with commas and place them inside square brackets. Example: `[personal, analysis, finance]`
|
135
|
-
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 `
|
136
|
-
|
146
|
+
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 you must use the list notation (use `[]` even if you have only one image), and each image should be provided as `"/path/to/img" : "Caption of image"`.
|
147
|
+
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.
|
148
|
+
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, giscus, CommentBox) 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`.
|
149
|
+
|
150
|
+
## Parameters for SEO and social media sharing
|
151
|
+
|
152
|
+
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).
|
153
|
+
|
154
|
+
Parameter | Description
|
155
|
+
----------- | -----------
|
156
|
+
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.
|
157
|
+
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.
|
158
|
+
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
159
|
|
138
160
|
## Less commonly used parameters
|
139
161
|
|
@@ -143,14 +165,12 @@ Parameter | Description
|
|
143
165
|
----------- | -----------
|
144
166
|
readtime | If you want a post to show how many minutes it will take to read it, use `readtime: true`.
|
145
167
|
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
168
|
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
|
169
|
+
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`
|
170
|
+
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
171
|
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
|
-
|
153
|
-
|
172
|
+
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.
|
173
|
+
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
174
|
|
155
175
|
## Advanced parameters
|
156
176
|
|
@@ -158,9 +178,12 @@ These are advanced parameters that are only useful for people who need very fine
|
|
158
178
|
|
159
179
|
Parameter | Description
|
160
180
|
----------- | -----------
|
161
|
-
footer-extra | If you want to include extra
|
181
|
+
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.
|
182
|
+
before-content | Similar to `footer-extra`, but used for including HTML before the main content of the page (below the title).
|
183
|
+
after-content | Similar to `footer-extra`, but used for including HTML after the main content of the page (above the footer).
|
184
|
+
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
185
|
language | HTML language code to be set on the page's <html> element.
|
163
|
-
|
186
|
+
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
187
|
js | List of local JavaScript files to include in the page (eg. `/assets/js/mypage.js`)
|
165
188
|
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
189
|
css | List of local CSS files to include in the page
|
@@ -174,88 +197,33 @@ ext-css | List of external CSS files to include in the page. External CSS f
|
|
174
197
|
- **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
198
|
- 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
199
|
|
177
|
-
#
|
200
|
+
# Featured users (success stories!)
|
178
201
|
|
179
|
-
|
202
|
+
Visit the [Official website](http://beautifuljekyll.com/examples) to see sample websites using Beautiful Jekyll.
|
180
203
|
|
181
|
-
|
204
|
+
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!
|
182
205
|
|
183
|
-
|
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 |
|
206
|
+
# Next steps
|
196
207
|
|
208
|
+
Congratulations on making it this far! You now have all the tools to easily build a beautiful website for free.
|
197
209
|
|
198
|
-
|
210
|
+
I highly recommend going over the [*Frequently Asked Questions*](https://beautifuljekyll.com/faq/) to find out answers to questions you may not even know you have. Every few months I suggest checking the [*What's New?*](https://beautifuljekyll.com/updates/) page to see if there are new features, and learn [how to update your site to the newest version](https://beautifuljekyll.com/faq/#updating) when it's time.
|
199
211
|
|
200
|
-
|
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 |
|
212
|
+
You can also check out the [advanced installation methods](https://beautifuljekyll.com/getstarted/#install-steps-hard) that give you a little more control but are harder to use. Keep in mind that Beautiful Jekyll was primarily designed to be used as a GitHub theme, so you will not get any support if you choose one of the Ruby installation methods.
|
213
213
|
|
214
|
-
#
|
214
|
+
# Getting help
|
215
215
|
|
216
|
-
|
216
|
+
Visit the [FAQ page](https://beautifuljekyll.com/faq) for answers to commonly asked questions.
|
217
217
|
|
218
|
-
|
218
|
+
**If you choose to [become a sponsor](https://beautifuljekyll.com/plans/), you'll have access to my [office hours](https://beautifuljekyll.com/officehours/) where you can ask for help.** You can also use the [Discussions](https://github.com/daattali/beautiful-jekyll/discussions) area to try and get help from the community.
|
219
219
|
|
220
|
-
|
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).
|
233
|
-
|
234
|
-
- ### What if I want a free domain, but not `https://<yourusername>.github.io`?
|
235
|
-
|
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`.
|
237
|
-
|
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?
|
247
|
-
|
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.
|
249
|
-
|
250
|
-
- ### How do I use math equations in my posts?
|
251
|
-
|
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.
|
220
|
+
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/).
|
253
221
|
|
254
222
|
# Contributions
|
255
223
|
|
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.
|
224
|
+
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
225
|
|
258
|
-
You can also contribute by becoming an [official sponsor](https://github.com/sponsors/daattali) to help keep
|
226
|
+
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
227
|
|
260
228
|
# Credits
|
261
229
|
|
@@ -263,7 +231,3 @@ This template was not made *entirely* from scratch. I'd like to give special tha
|
|
263
231
|
|
264
232
|
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
233
|
|
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
|
-
|
data/_data/ui-text.yml
CHANGED
@@ -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
|
# --------------
|
@@ -0,0 +1,8 @@
|
|
1
|
+
{% if site.cloudflare_analytics %}
|
2
|
+
<!-- Cloudflare Web Analytics -->
|
3
|
+
<script defer
|
4
|
+
src='https://static.cloudflareinsights.com/beacon.min.js'
|
5
|
+
data-cf-beacon='{"token": "{{ site.cloudflare_analytics}}"}'>
|
6
|
+
</script>
|
7
|
+
<!-- End Cloudflare Web Analytics -->
|
8
|
+
{% endif %}
|
data/_includes/comments.html
CHANGED
@@ -1,6 +1,8 @@
|
|
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
|
-
{%
|
6
|
+
{% include giscus-comment.html %}
|
7
|
+
{% include commentbox.html %}
|
8
|
+
{% 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 %}
|
data/_includes/footer.html
CHANGED
@@ -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
|
-
{%
|
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
|
•
|
20
|
-
<
|
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 %}
|
@@ -26,12 +30,17 @@
|
|
26
30
|
<a href="http://{{- site.matomo.uri -}}/index.php?module=CoreAdminHome&action=optOut" target="_blank" class="text_muted">Do-not-Track</a>
|
27
31
|
{% endif %}
|
28
32
|
{% endif%}
|
33
|
+
|
34
|
+
{% if site.edit_page_button and site.github.repository_url %}
|
35
|
+
•
|
36
|
+
<a title="Edit this page on GitHub" href="{{ site.github.repository_url }}/edit/{{ site.github.source.branch }}/{{ page.path }}" class="text_muted">Edit page</a>
|
37
|
+
{% endif%}
|
38
|
+
|
29
39
|
</p>
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
</p>
|
40
|
+
{% unless site.remove-ads %}<p class="theme-by text-muted">
|
41
|
+
Powered by
|
42
|
+
<a href="https://beautifuljekyll.com">Beautiful Jekyll</a>
|
43
|
+
</p>{% endunless %}
|
35
44
|
</div>
|
36
45
|
</div>
|
37
46
|
</div>
|
@@ -0,0 +1,16 @@
|
|
1
|
+
{% if site.giscus.repository and site.giscus.hostname %}
|
2
|
+
|
3
|
+
<script src="https://{{ site.giscus.hostname }}/client.js"
|
4
|
+
data-repo="{{ site.giscus.repository }}"
|
5
|
+
data-repo-id="{{ site.giscus.repository-id }}"
|
6
|
+
data-category="{{ site.giscus.category }}"
|
7
|
+
data-category-id="{{ site.giscus.category-id }}"
|
8
|
+
data-mapping="{{ site.giscus.mapping }}"
|
9
|
+
data-reactions-enabled="{{ site.giscus.reactions-enabled }}"
|
10
|
+
data-emit-metadata="{{ site.giscus.emit-metadata }}"
|
11
|
+
data-theme="{{ site.giscus.theme }}"
|
12
|
+
crossorigin="anonymous"
|
13
|
+
async>
|
14
|
+
</script>
|
15
|
+
|
16
|
+
{% endif %}
|
@@ -1,5 +1,17 @@
|
|
1
1
|
{% if site.google_analytics %}
|
2
2
|
<!-- Google Analytics -->
|
3
|
+
{% unless site.gtag %}
|
4
|
+
<div id="bj-ganalytics-deprecated-msg" style="position: fixed; background: #b90404; bottom: 0; width: 100%; z-index: 10000; color: #f0f0f0; text-align: center;">
|
5
|
+
<div title="Close" onclick="$(this).parent().remove()" style="position: absolute; right: 5px; top: 0; font-size: 1.5em; line-height: 1; cursor: pointer;">×</div>
|
6
|
+
<div style="max-width: 800px; margin: auto; font-size: 1.1em">
|
7
|
+
This website is using outdated Google Analytics
|
8
|
+
<details style="font-size: 0.8em; margin-bottom: 5px;">
|
9
|
+
<summary>More info</summary>
|
10
|
+
As of July 2023, Google's Universal Analytics is going away and being replaced by Google Analytics 4. This website is still using the old Universal Analytics. In order to remove this message, the website owner must remove the <code>google_analytics</code> property in the website's config file, and optionally replace it with the new <code>gtag</code> property.
|
11
|
+
</details>
|
12
|
+
</div>
|
13
|
+
</div>
|
14
|
+
{% endunless %}
|
3
15
|
<script>
|
4
16
|
(function (i, s, o, g, r, a, m) {
|
5
17
|
i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
|