beautiful-jekyll-theme 4.0.1 → 4.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +26 -19
- data/_includes/head.html +24 -4
- data/assets/css/main.css +3 -3
- data/staticman.yml +110 -0
- metadata +17 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4d8b59dc9b92ac72d4fb06b368d9ed8bf85eb660b02d2b488b2cd0ec5dc6e523
|
|
4
|
+
data.tar.gz: 62db8a1cdb5fb75bdbb0bffeb381298df5121a3af0b8b710b017088b77bb27e6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8aba279446b8aa539d9419ada18f91ab42e33fba348678c2aa40770a4249625250cf3fc293c3b683f10d1c666b559a359d5a9a882aa2d0965952d2fffbed1cac
|
|
7
|
+
data.tar.gz: 85802295e3b5c95a2405758fba3dd2029a300dfb2a851ec8868a634cde067edb86ef4d6244160340f7eb74e583a4b781a76e72d3f9256c402fda25bdd32cacef
|
data/README.md
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
|
+
[](https://xscode.com/daattali/beautiful-jekyll)
|
|
2
|
+
|
|
1
3
|
# Beautiful Jekyll
|
|
2
4
|
|
|
3
5
|
[](https://xscode.com/daattali/beautiful-jekyll)
|
|
4
6
|
[](https://badge.fury.io/rb/beautiful-jekyll-theme)
|
|
5
|
-
[](https://github.com/daattali/beautiful-jekyll/actions?query=branch%3Amaster+event%3Apush+workflow%3A%22Beautiful+Jekyll+CI%22)
|
|
6
7
|
|
|
7
|
-
> *
|
|
8
|
+
> *Created by [Dean Attali](https://deanattali.com)* · [Demo](https://beautifuljekyll.com/)
|
|
8
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
11
|
|
|
11
|
-
**If you enjoy this theme, please consider [
|
|
12
|
+
**If you enjoy this theme, please consider [supporting me](https://github.com/sponsors/daattali) for developing and maintaining it for over 5 years.**
|
|
12
13
|
|
|
13
14
|
<p align="center">
|
|
14
15
|
<a style="display: inline-block;" href="https://github.com/sponsors/daattali">
|
|
@@ -122,7 +123,7 @@ If you don't include YAML then your file will not use this template.
|
|
|
122
123
|
|
|
123
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.
|
|
124
125
|
|
|
125
|
-
## Main
|
|
126
|
+
## Main parameters
|
|
126
127
|
|
|
127
128
|
These are the basic YAML parameters that you are most likely to use on most pages.
|
|
128
129
|
|
|
@@ -149,6 +150,7 @@ nav-short | By default, the navigation bar gets shorter after scrolling down t
|
|
|
149
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.
|
|
150
151
|
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.
|
|
151
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).
|
|
152
154
|
|
|
153
155
|
## Advanced parameters
|
|
154
156
|
|
|
@@ -174,7 +176,7 @@ ext-css | List of external CSS files to include in the page. External CSS f
|
|
|
174
176
|
|
|
175
177
|
# Showcased users (success stories!)
|
|
176
178
|
|
|
177
|
-
Beautiful Jekyll has been used in
|
|
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!
|
|
178
180
|
|
|
179
181
|
## Project/company websites
|
|
180
182
|
|
|
@@ -217,33 +219,37 @@ Beautiful Jekyll is actively used by thousands of people with wildly varying deg
|
|
|
217
219
|
|
|
218
220
|
**If you really wany my personal help, please visit https://xscode.com/daattali/beautiful-jekyll to hire my services.**
|
|
219
221
|
|
|
220
|
-
###
|
|
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.
|
|
221
225
|
|
|
222
|
-
|
|
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 ...?
|
|
223
227
|
|
|
224
|
-
|
|
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.
|
|
225
229
|
|
|
226
|
-
|
|
230
|
+
- ### What if I want to use a custom domain for my site?
|
|
227
231
|
|
|
228
|
-
|
|
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).
|
|
229
233
|
|
|
230
|
-
|
|
234
|
+
- ### What if I want a free domain, but not `https://<yourusername>.github.io`?
|
|
231
235
|
|
|
232
|
-
|
|
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`.
|
|
233
237
|
|
|
234
|
-
|
|
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"!).
|
|
235
239
|
|
|
236
|
-
|
|
240
|
+
Now your website will be at `https://<yourusername>.github.io\MyAwesomeProject`.
|
|
237
241
|
|
|
238
|
-
|
|
242
|
+
- ### How do I move the blog to another page instead of having it on the home page?
|
|
239
243
|
|
|
240
|
-
|
|
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/"`).
|
|
241
245
|
|
|
242
|
-
|
|
246
|
+
- ### What size do you recommend using for the `cover-img` photos?
|
|
243
247
|
|
|
244
|
-
|
|
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.
|
|
245
249
|
|
|
246
|
-
|
|
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.
|
|
247
253
|
|
|
248
254
|
# Contributions
|
|
249
255
|
|
|
@@ -260,3 +266,4 @@ I'd also like to thank [Dr. Jekyll's Themes](https://drjekyllthemes.github.io/),
|
|
|
260
266
|
# Known limitations
|
|
261
267
|
|
|
262
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/_includes/head.html
CHANGED
|
@@ -3,15 +3,25 @@
|
|
|
3
3
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
|
|
4
4
|
|
|
5
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>
|
|
6
|
-
|
|
6
|
+
|
|
7
7
|
{% if site.author %}
|
|
8
8
|
<meta name="author" content="{{ site.author }}">
|
|
9
9
|
{% endif %}
|
|
10
|
-
|
|
11
|
-
{% if page.
|
|
10
|
+
|
|
11
|
+
{% if page.description %}
|
|
12
|
+
<meta name="description" content="{{ page.description }}">
|
|
13
|
+
{% elsif page.subtitle %}
|
|
12
14
|
<meta name="description" content="{{ page.subtitle }}">
|
|
13
15
|
{% endif %}
|
|
14
16
|
|
|
17
|
+
{% if site.mobile-theme-col %}
|
|
18
|
+
<meta name="theme-color" content="{{ site.mobile-theme-col }}">
|
|
19
|
+
{% endif %}
|
|
20
|
+
|
|
21
|
+
{% if site.keywords %}
|
|
22
|
+
<meta name="keywords" content="{{ site.keywords }}">
|
|
23
|
+
{% endif %}
|
|
24
|
+
|
|
15
25
|
<link rel="alternate" type="application/rss+xml" title="{{ site.title | default: 'Untitled' }} {{ site.title-separator | default: '-' }} {{ site.description }}" href="{{ '/feed.xml' | absolute_url }}">
|
|
16
26
|
|
|
17
27
|
{% include gtag.html %}
|
|
@@ -42,11 +52,21 @@
|
|
|
42
52
|
{% endfor %}
|
|
43
53
|
{% endif %}
|
|
44
54
|
|
|
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
|
+
|
|
45
61
|
<!-- Facebook OpenGraph tags -->
|
|
46
62
|
{% if site.fb_app_id %}
|
|
47
63
|
<meta property="fb:app_id" content="{{ site.fb_app_id }}">
|
|
48
64
|
{% endif %}
|
|
49
65
|
|
|
66
|
+
{% if site.title %}
|
|
67
|
+
<meta property="og:site_name" content="{{ site.title }}">
|
|
68
|
+
{% endif %}
|
|
69
|
+
|
|
50
70
|
{% if page.meta-title %}
|
|
51
71
|
<meta property="og:title" content="{{ page.meta-title }}">
|
|
52
72
|
{% elsif page.title %}
|
|
@@ -55,7 +75,7 @@
|
|
|
55
75
|
<meta property="og:title" content="{{ site.title }}">
|
|
56
76
|
{% endif %}
|
|
57
77
|
|
|
58
|
-
|
|
78
|
+
{% if page.meta-description %}
|
|
59
79
|
<meta property="og:description" content="{{ page.meta-description }}">
|
|
60
80
|
{% elsif page.subtitle %}
|
|
61
81
|
<meta property="og:description" content="{{ page.subtitle }}">
|
data/assets/css/main.css
CHANGED
|
@@ -13,7 +13,7 @@ html {
|
|
|
13
13
|
body {
|
|
14
14
|
font-family: 'Lora', 'Times New Roman', serif;
|
|
15
15
|
font-size: 1.125rem;
|
|
16
|
-
color: #404040;
|
|
16
|
+
color: {{ site.text-col | default: "#404040" }};
|
|
17
17
|
position: relative;
|
|
18
18
|
background-color: {{ site.page-col | default: "#FFFFFF" }};
|
|
19
19
|
{% if site.page-img %}
|
|
@@ -447,7 +447,7 @@ footer .footer-custom-content {
|
|
|
447
447
|
|
|
448
448
|
.post-preview a {
|
|
449
449
|
text-decoration: none;
|
|
450
|
-
color: #404040;
|
|
450
|
+
color: {{ site.text-col | default: "#404040" }};
|
|
451
451
|
}
|
|
452
452
|
|
|
453
453
|
.post-preview a:focus,
|
|
@@ -761,7 +761,7 @@ footer .footer-custom-content {
|
|
|
761
761
|
padding: 0.625rem 0.3125rem;
|
|
762
762
|
background-color: #FFF;
|
|
763
763
|
border-radius: 0;
|
|
764
|
-
color: #404040;
|
|
764
|
+
color: {{ site.text-col | default: "#404040" }};
|
|
765
765
|
}
|
|
766
766
|
@media (min-width: 768px) {
|
|
767
767
|
.pagination .page-item .page-link {
|
data/staticman.yml
ADDED
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# Name of the property. You can have multiple properties with completely
|
|
2
|
+
# different config blocks for different sections of your site.
|
|
3
|
+
# For example, you can have one property to handle comment submission and
|
|
4
|
+
# another one to handle posts.
|
|
5
|
+
# To encrypt strings use the following endpoint:
|
|
6
|
+
# https://{STATICMAN API INSTANCE}/v3/encrypt/{TEXT TO BE ENCRYPTED}
|
|
7
|
+
# {STATICMAN API INSTANCE} should match the `endpoint` in the theme config
|
|
8
|
+
# file. It defaults to "staticman3.herokuapp.com".
|
|
9
|
+
|
|
10
|
+
comments:
|
|
11
|
+
# (*) REQUIRED
|
|
12
|
+
#
|
|
13
|
+
# Names of the fields the form is allowed to submit. If a field that is
|
|
14
|
+
# not here is part of the request, an error will be thrown.
|
|
15
|
+
allowedFields: ["name", "email", "url", "message"]
|
|
16
|
+
|
|
17
|
+
# (*) REQUIRED WHEN USING NOTIFICATIONS
|
|
18
|
+
#
|
|
19
|
+
# When allowedOrigins is defined, only requests sent from one of the domains
|
|
20
|
+
# listed will be accepted. The origin is sent as part as the `options` object
|
|
21
|
+
# (e.g. <input name="options[origin]" value="https://yourdomain.com/post1")
|
|
22
|
+
# allowedOrigins: ["https://example.com"]
|
|
23
|
+
|
|
24
|
+
# (*) REQUIRED
|
|
25
|
+
#
|
|
26
|
+
# Name of the branch being used. Must match the `branch` in the theme config
|
|
27
|
+
# file.
|
|
28
|
+
branch: "master" # use "master" for user page or "gh-pages" for project pages
|
|
29
|
+
|
|
30
|
+
commitMessage: "New comment by {fields.name}"
|
|
31
|
+
|
|
32
|
+
# (*) REQUIRED
|
|
33
|
+
#
|
|
34
|
+
# Destination path (filename) for the data files. Accepts placeholders.
|
|
35
|
+
filename: "comment-{@timestamp}"
|
|
36
|
+
|
|
37
|
+
# The format of the generated data files. Accepted values are "json", "yaml"
|
|
38
|
+
# or "frontmatter"
|
|
39
|
+
format: "yaml"
|
|
40
|
+
|
|
41
|
+
# List of fields to be populated automatically by Staticman and included in
|
|
42
|
+
# the data file. Keys are the name of the field. The value can be an object
|
|
43
|
+
# with a `type` property, which configures the generated field, or any value
|
|
44
|
+
# to be used directly (e.g. a string, number or array)
|
|
45
|
+
generatedFields:
|
|
46
|
+
date:
|
|
47
|
+
type: "date"
|
|
48
|
+
options:
|
|
49
|
+
format: "iso8601" # "iso8601" (default), "timestamp-seconds", "timestamp-milliseconds"
|
|
50
|
+
|
|
51
|
+
# Whether entries need to be approved before they are published to the main
|
|
52
|
+
# branch. If set to `true`, a pull request will be created for your approval.
|
|
53
|
+
# Otherwise, entries will be published to the main branch automatically.
|
|
54
|
+
moderation: false
|
|
55
|
+
|
|
56
|
+
# Akismet spam detection.
|
|
57
|
+
# akismet:
|
|
58
|
+
# enabled: true
|
|
59
|
+
# author: "name"
|
|
60
|
+
# authorEmail: "email"
|
|
61
|
+
# authorUrl: "url"
|
|
62
|
+
# content: "message"
|
|
63
|
+
# type: "comment"
|
|
64
|
+
|
|
65
|
+
# Name of the site. Used in notification emails.
|
|
66
|
+
# name: "Your Site"
|
|
67
|
+
|
|
68
|
+
# Notification settings. When enabled, users can choose to receive notifications
|
|
69
|
+
# via email when someone adds a reply or a new comment. This requires an account
|
|
70
|
+
# with Mailgun, which you can get for free at https://mailgun.com.
|
|
71
|
+
# notifications:
|
|
72
|
+
# Enable notifications
|
|
73
|
+
# enabled: true
|
|
74
|
+
|
|
75
|
+
# (!) ENCRYPTED
|
|
76
|
+
#
|
|
77
|
+
# Mailgun API key
|
|
78
|
+
# apiKey: ""
|
|
79
|
+
|
|
80
|
+
# (!) ENCRYPTED
|
|
81
|
+
#
|
|
82
|
+
# Mailgun domain (encrypted)
|
|
83
|
+
# domain: ""
|
|
84
|
+
|
|
85
|
+
# (*) REQUIRED
|
|
86
|
+
#
|
|
87
|
+
# Destination path (directory) for the data files. Accepts placeholders.
|
|
88
|
+
path: "_data/comments/{options.slug}" # (default)
|
|
89
|
+
|
|
90
|
+
# Names of required files. If any of these isn't in the request or is empty,
|
|
91
|
+
# an error will be thrown.
|
|
92
|
+
requiredFields: ["name", "email", "message"]
|
|
93
|
+
|
|
94
|
+
# List of transformations to apply to any of the fields supplied. Keys are
|
|
95
|
+
# the name of the field and values are possible transformation types.
|
|
96
|
+
transforms:
|
|
97
|
+
email: md5
|
|
98
|
+
|
|
99
|
+
# reCAPTCHA (OPTIONAL)
|
|
100
|
+
# To enable reCAPTCHA:
|
|
101
|
+
# 1. Set `enabled` to `true`
|
|
102
|
+
# 2. Register your domain at https://www.google.com/recaptcha/ and choose reCAPTCHA V2
|
|
103
|
+
# 3. Uncomment `siteKey` and `secret` and fill them in with your values
|
|
104
|
+
reCaptcha:
|
|
105
|
+
enabled: false
|
|
106
|
+
#siteKey: ""
|
|
107
|
+
# ENCRYPT reCaptcha secret key using Staticman /encrypt endpoint
|
|
108
|
+
# i.e. https://{STATICMAN API INSTANCE}/v3/encrypt/{your-site-secret}
|
|
109
|
+
# For more information, visit https://staticman.net/docs/encryption
|
|
110
|
+
#secret: ""
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: beautiful-jekyll-theme
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 4.0
|
|
4
|
+
version: 4.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Dean Attali
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2020-
|
|
11
|
+
date: 2020-08-08 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -52,6 +52,20 @@ dependencies:
|
|
|
52
52
|
- - "~>"
|
|
53
53
|
- !ruby/object:Gem::Version
|
|
54
54
|
version: '1.4'
|
|
55
|
+
- !ruby/object:Gem::Dependency
|
|
56
|
+
name: kramdown-parser-gfm
|
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
|
58
|
+
requirements:
|
|
59
|
+
- - "~>"
|
|
60
|
+
- !ruby/object:Gem::Version
|
|
61
|
+
version: '1.1'
|
|
62
|
+
type: :runtime
|
|
63
|
+
prerelease: false
|
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
65
|
+
requirements:
|
|
66
|
+
- - "~>"
|
|
67
|
+
- !ruby/object:Gem::Version
|
|
68
|
+
version: '1.1'
|
|
55
69
|
- !ruby/object:Gem::Dependency
|
|
56
70
|
name: bundler
|
|
57
71
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -135,6 +149,7 @@ files:
|
|
|
135
149
|
- assets/js/main.js
|
|
136
150
|
- assets/js/staticman.js
|
|
137
151
|
- feed.xml
|
|
152
|
+
- staticman.yml
|
|
138
153
|
- tags.html
|
|
139
154
|
homepage: https://beautifuljekyll.com
|
|
140
155
|
licenses:
|