beautiful-jekyll-theme 2.3.0 → 3.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: 16d6e98a7d9ba9dac7b0d13b98bde18eed1cdfa4ddb1d471c79443e562757f7b
4
- data.tar.gz: f3fc30b9193b7244a370242d565974c9af79ff527b1f70731a2571c795a76c53
3
+ metadata.gz: 95d23069f17ab48c9de07cc4e7695fe4dc2773f360bd793fefeee2ecc0926db5
4
+ data.tar.gz: 750ce3210520e7802f77a99e18359ec1e14e45e5c91eddb033585813306cada4
5
5
  SHA512:
6
- metadata.gz: 9220bbdd313a57fa061f553764db42e80286e01dc7870cf9f1cba83a248212c5ed58ae14902dea2c90371cdb246dfdc4facc05aa3fd11293a8cfc6319d96aa3e
7
- data.tar.gz: 9a761b938b7388edc553039cb72f2a6bf1f81ca9abf55ccb6be9c90de1789b31033de30f00584bb5a236fb4c2046c0c113f27cab6b2dc1fbed948eb06a40a7c0
6
+ metadata.gz: f7bcfe0897999580b7a0941bd93fa98dc5b3406d3d4f03ece0647c32d1991f15c6941788acb009bd5d0038905c28ad7998958665a45ccba6907803395e42f6bb
7
+ data.tar.gz: 1b6ec84ed1bb74c27a420bc26ba53009c3a1e026080437765d05b75cfea5f08ac3f65345006800769a084dd175f6ceb4032a0021f47acf0dfa93b41ef1eb99ce
data/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  > *Copyright 2020 [Dean Attali](https://deanattali.com)*
7
7
 
8
- **Beautiful Jekyll** is a ready-to-use template to help you create an awesome website quickly. Perfect for personal sites, blogs, or simple project websites. [Check out a demo](https://beautifuljekyll.com) of what you'll get after just two minutes. You can also look at [my personal website](https://deanattali.com) to see it in use, or see examples of websites other people created using this theme [below](#showcased-users-success-stories).
8
+ **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).
9
9
 
10
10
  **If you enjoy this theme, please consider [supporting me](http://paypal.me/daattali) or [sponsoring me](https://github.com/sponsors/daattali) for developing and maintaining it for over 5 years.**
11
11
 
@@ -18,38 +18,38 @@
18
18
  </a>
19
19
  </p>
20
20
 
21
- ### Table of contents
21
+ ## Table of contents
22
22
 
23
23
  - [Features](#features)
24
- - [Build your website in 3 steps](#build-your-website-in-3-steps)
24
+ - [**Build your website in 3 steps**](#build-your-website-in-3-steps)
25
25
  - [Add your own content](#add-your-own-content)
26
- - [Last important thing: parameters for each page](#last-important-thing-parameters-for-each-page)
27
- - [Supported YAML front matter parameters](#supported-yaml-front-matter-parameters)
26
+ - [Customizing parameters for each page](#customizing-parameters-for-each-page)
27
+ - [Supported parameters](#supported-parameters)
28
28
  - [Showcased users (success stories!)](#showcased-users-success-stories)
29
29
  - [FAQ and support](#faq-and-support)
30
30
  - [Credits and contributions](#credits)
31
31
 
32
- ## Features
32
+ # Features
33
33
 
34
34
  - **SIMPLE**: The primary goal of Beautiful Jekyll is to allow literally *anyone* to create a website in a few minutes.
35
+ - **Modern**: Uses the latest best practices and technologies to achieve nearly perfect scores on Google Chrome's Audit.
35
36
  - **Mobile-first**: Designed to look great on both large-screen and small-screen (mobile) devices.
36
37
  - **Highly customizable**: Many personalization settings such as changing the background colour/image, adding a logo.
37
- - **Two-level navigation menu**: If you have many pages and your menu is getting cluttered, separate your menu into two levels.
38
- - **Flexible usage**: Install Beautiful Jekyll directly from GitHub or using a Ruby gem - choose the right [development method](#build-your-website-in-3-steps) for you.
38
+ - **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.
39
39
  - **Battle-tested**: By using Beautiful Jekyll, you'll be joining tens of thousands of users who used this theme since 2015.
40
40
  - **Links to your social media**: You can easily add links to any of your social media accounts in the footer of every page.
41
- - **Comments support**: Add comments to any page using one of the supported commenting platforms: [Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), [Utterances](https://utteranc.es/), or [Staticman](https://staticman.net).
42
- - **Sharing blog posts on social media**: By default, all blog posts have buttons to allow people to share on Twitter/Facebook/LinkedIn.
41
+ - **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).
42
+ - **Share blog posts on social media**: By default, all blog posts have buttons to allow people to share on Twitter/Facebook/LinkedIn.
43
43
  - **Tags**: Any blog post can be tagged with keywords, and an index page showing all the tags is automatically generated.
44
44
  - **Tracking analytics**: Easily integrate Google Analytics, or other analytics platforms, to track visits to your website.
45
45
  - **Photos support**: Any page can have a cover photo around its title, and any blog post can have an associated image.
46
46
  - **More advanced features**: I wrote [a blog post](https://deanattali.com/2015/03/12/beautiful-jekyll-how-to-build-a-site-in-minutes/) describing some more advanced features that I used in my website that can be used in any beautiful-jekyll site.
47
47
 
48
- ## Build your website in 3 steps
48
+ # Build your website in 3 steps
49
49
 
50
50
  There's a very easy way to use this theme, and there's a hard way. For most people (including myself!), I suggest going the easy route. If you're an advanced user and want to tinker with the hard way (using ruby gems), then [skip the easy way](https://github.com/daattali/beautiful-jekyll#the-hard-way-using-ruby-gems) if you know what you're doing.
51
51
 
52
- ### The easy way (recommended!)
52
+ ## The easy way (recommended!)
53
53
 
54
54
  Getting started is *literally* as easy as 1-2-3 :smile:
55
55
 
@@ -57,40 +57,44 @@ Scroll down to see the steps involved, but here is a 40-second video just as a r
57
57
 
58
58
  ![Installation steps](assets/img/install-steps.gif)
59
59
 
60
- #### 1. Fork this project
60
+ ### 1. Fork this project
61
61
 
62
62
  Fork this project by clicking the __*Fork*__ button at the top right corner of this page. Forking means that you now copied this entire project and all the files into your account.
63
63
 
64
- #### 2. Rename the project to `<yourusername>.github.io`
64
+ ### 2. Rename the project to `<yourusername>.github.io`
65
65
 
66
66
  Click on __*Settings*__ at the top (the cog icon) and on that page you'll have an option to rename the project (*repository name*). This will create a website with the **Beautiful Jekyll** template that will be available at `https://<yourusername>.github.io` within a couple minutes. Check out the [FAQ](#faq-and-support) if you want to use a different project name.
67
67
 
68
- #### 3. Customize your website settings
68
+ ### 3. Customize your website settings
69
69
 
70
70
  Edit the `_config.yml` file to change any settings you want. To edit the file, click on it to view the file and then click on the pencil icon to edit it (watch the video tutorial above if you're confused). The settings in the file are self-explanatory and I added comments inside the file to help you understand what each setting does. Any line that begins with a hashtag (`#`) is a comment, and the other lines are actual settings.
71
71
 
72
- #### 4. Congratulations! You have a website!
72
+ ### 4. Congratulations! You have a website!
73
73
 
74
74
  After you save your changes to the config file (by clicking on *Commit changes* as the video tutorial shows), your website should be ready in a minute or two at `https://<yourusername>.github.io`. Every time you make a change to any file, your website will get rebuilt and should be updated in about a minute or so. Your website will be initialized with several sample blog posts and a couple other pages.
75
75
 
76
76
  Note that in the video above I only edited one setting in the `_config.yml` file. **You should actually go through the rest of the settings as well. Don't be lazy, go through all the settings :)**
77
77
 
78
- ### The hard way (using ruby gems)
78
+ ## The hard way (using ruby gems)
79
79
 
80
80
  If you followed the easy method above, then you already have your site and you can skip this section! If you want to install beautiful-jekyll using ruby gems instead, follow the [advanced installation instructions](https://beautifuljekyll.com/getstarted/#install-steps-hard).
81
81
 
82
82
 
83
- ## Add your own content
83
+ # Add your own content
84
84
 
85
- To add pages to your site, you can either write a markdown file (`.md`) or you can write an HTML file directly. It's much easier to write markdown than HTML, so I suggest you do that (use [this great tutorial](https://markdowntutorial.com/) if you need to learn markdown in 5 minutes). You can look at some files on this site to get an idea of how to write markdown. To look at existing files, click on any file that ends in `.md`, for example [`aboutme.md`](./aboutme.md). On the next page you can see some nicely formatted text (there's a word in bold, a link, a few bullet points), and if you click on the pencil icon to edit the file, you'll see the markdown that generated the pretty text. Very easy!
85
+ 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.
86
+
87
+ 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!
86
88
 
87
89
  In contrast, look at [`tags.html`](./tags.html). That's how your write HTML - not as pretty. So stick with markdown if you don't know HTML.
88
90
 
91
+ 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`.
92
+
89
93
  Files you create inside the [`_posts`](./_posts) directory will be treated as blog entries. You can look at the existing files there to get an idea of how to write blog posts. Note the format of the blog post files - they must follow the naming convention of `YEAR-MONTH-DAY-title.md`. After you successfully add your own post, you can delete the existing files inside [`_posts`](./_posts) to remove the sample posts, as those are just demo posts to help you learn.
90
94
 
91
- ## Last important thing: parameters for each page
95
+ # Customizing parameters for each page
92
96
 
93
- In order to have your new pages use this template and not just be plain HTML pages, **you must add [YAML front matter](https://jekyllrb.com/docs/front-matter/) to the top of each page**. This is where you'll be able to give each page some extra parameters such as a title, a subtitle, or an image. [Below is a list of all available parameters](#supported-yaml-front-matter-parameters). If you don't want to use any parameters on a page (this also means having no title), then use the empty YAML front matter:
97
+ **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:
94
98
 
95
99
  ```
96
100
  ---
@@ -112,36 +116,53 @@ You can look at the top of [`aboutme.md`](https://raw.githubusercontent.com/daat
112
116
 
113
117
  If you don't include YAML then your file will not use this template.
114
118
 
115
- ## Supported YAML front matter parameters
119
+ # Supported parameters
120
+
121
+ 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.
116
122
 
117
- These are the main parameters you can place inside a page's YAML front matter that **Beautiful Jekyll** supports.
123
+ ## Main paramaters
124
+
125
+ These are the basic YAML parameters that you are most likely to use on most pages.
118
126
 
119
127
  Parameter | Description
120
128
  ----------- | -----------
121
129
  title | Page or blog post title
122
130
  subtitle | Short description of page or blog post that goes under the title
123
- tags | List of tags to categorize the post. Separate the tags with commas and place them inside square brackets. Example: `[personal, self help, finance]`
124
- bigimg | Include a large full-width image at the top of the page. You can either give the path to a single image, or provide a list of images to cycle through (see [my personal website](https://deanattali.com/) as an example).
125
- comments | If you want do add comments to a specific page, use `comments: true`. Comments are automatically enabled on blog posts; to turn comments off for a specific post, use `comments: false`. Comments only work if you enable at least one provider(Facebook, disqus, staticman) in `_config.yml` file.
126
- show-avatar | If you have an avatar configured in the `_config.yml` but you want to turn it off on a specific page, use `show-avatar: false`. If you want to turn it off by default, locate the line `show-avatar: true` in the file `_config.yml` and change the `true` to `false`; then you can selectively turn it on in specific pages using `show-avatar: true`.
127
- image | If you want to add a personalized image to your blog post that will show up next to the post's excerpt and on the post itself, use `image: /path/to/img`.
128
- readtime | If you want to show how many minutes it will take to read a post in the header, add `readtime: true`.
131
+ tags | List of tags to categorize the post. Separate the tags with commas and place them inside square brackets. Example: `[personal, analysis, finance]`
132
+ cover-img | Include a large full-width image at the top of the page. You can either give the path to a single image, or provide a list of images to cycle through (see [my personal website](https://deanattali.com/) as an example).
133
+ 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`.
134
+
135
+ ## Less commonly used parameters
136
+
137
+ These are parameters that you may not use often, but can come in handy sometimes.
138
+
139
+ Parameter | Description
140
+ ----------- | -----------
141
+ readtime | If you want a post to show how many minutes it will take to read it, use `readtime: true`.
142
+ 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`.
143
+ image | If you want to add an image to your blog post that will show up next to the post's excerpt on the feed and in the post page itself, use `image: /path/to/img`.
129
144
  share-img | If you want to specify an image to use when sharing the page on Facebook or Twitter, then provide the image's full URL here.
130
- social-share | If you don't want to show buttons to share a blog post on social media, use `social-share: false` (this feature is turned on by default).
131
- footer-extra | If you want to include extra information in the footer, create an HTML file in the `_includes/` folder (for example `_includes/myinfo.html`) and set `footer-extra` to the name of the file (for example `footer-extra: myinfo.html`)
145
+ 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`.
132
146
  nav-short | By default, the navigation bar gets shorter after scrolling down the page. If you want the navigation bar to always be short on a certain page, use `nav-short: true`
133
- use-site-title | If you want to use the site title rather than page title as HTML document title (ie. browser tab title), use `use-site-title: true`. When set, the document title will take the format `Site Title - Site Description` (eg. `My website - A virtual proof that name is awesome!`). By default, it will use `Page Title` if it exists, or `Site Title` otherwise.
134
- language | HTML language code to be set on &lt;html&gt; element (see [W3Schools website](https://www.w3schools.com/tags/ref_language_codes.asp) for more info on this topic). Language can also be set site-wide in `_config.yml`.
135
- layout | What type of page this is (default is `post` for blog posts and `page` for other pages). See _Page types_ section below for more information.
136
147
  gh-repo   | If you want to show GitHub buttons at the top of a post, this sets the GitHub repo name (eg. `daattali/beautiful-jekyll`). You must also use the `gh-badge` parameter to specify what buttons to show.
137
148
  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.
149
+ 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.
150
+
151
+ ## Advanced parameters
152
+
153
+ These are advanced parameters that are only useful for people who need very fine control over their website.
154
+
155
+ Parameter | Description
156
+ ----------- | -----------
157
+ 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`)
158
+ language | HTML language code to be set on the page's &lt;html&gt; element.
159
+ 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`.
138
160
  js | List of local JavaScript files to include in the page (eg. `/assets/js/mypage.js`)
139
161
  ext-js | List of external JavaScript files to include in the page (eg. `//cdnjs.cloudflare.com/ajax/libs/underscore.js/1.8.2/underscore-min.js`). External JavaScript files that support [Subresource Integrity (SRI)](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) can be specified using the `href` and `sri` parameters eg.<br/>`href: "//code.jquery.com/jquery-3.1.1.min.js"`<br/>`sri: "sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8="`
140
162
  css | List of local CSS files to include in the page
141
163
  ext-css | List of external CSS files to include in the page. External CSS files using SRI (see `ext-js` parameter) are also supported.
142
- googlefonts | List of Google fonts to include in the page (eg. `["Monoton", "Lobster"]`)
143
164
 
144
- ### Page types
165
+ ## Page types
145
166
 
146
167
  - **post** - To write a blog post, add a markdown or HTML file in the `_posts` folder. As long as you give it YAML front matter (the two lines of three dashes), it will automatically be rendered like a blog post. Look at the existing blog post files to see examples of how to use YAML parameters in blog posts.
147
168
  - **page** - Any page outside the `_posts` folder that uses YAML front matter will have a very similar style to blog posts.
@@ -149,18 +170,17 @@ googlefonts | List of Google fonts to include in the page (eg. `["Monoton", "Lob
149
170
  - **minimal** - If you want to create a page with minimal styling (ie. without the bulky navigation bar and footer), assign `layout: minimal` to the YAML front matter.
150
171
  - If you want to completely bypass the template engine and just write your own HTML page, simply omit the YAML front matter. Only do this if you know how to write HTML!
151
172
 
152
- ## Showcased users (success stories!)
173
+ # Showcased users (success stories!)
153
174
 
154
175
  Beautiful Jekyll has been used in over 500 websites in its first 6 months, and tens of thousands of times since its inception. Here is a sample of some websites that use Beautiful Jekyll.
155
176
 
156
- ### Project/company websites
177
+ ## Project/company websites
157
178
 
158
179
  | Website | Description |
159
180
  | :------ |:----------- |
160
181
  | [repidemicsconsortium.org/](https://www.repidemicsconsortium.org/) | R Epidemics Consortium |
161
182
  | [vaccineimpact.org](https://www.vaccineimpact.org/) | Vaccine Impact Modelling Consortium |
162
183
  | [derekogle.com/fishR](http://derekogle.com/fishR/) | Using R for Fisheries Analyses |
163
- | [bigdata.juju.solutions](http://bigdata.juju.solutions) | Creating Big Data solutions Juju Solutions |
164
184
  | [joecks.github.io/clipboard-actions](http://joecks.github.io/clipboard-actions/) | Clipboard Actions - an Android app |
165
185
  | [deanattali.com/shinyjs](http://deanattali.com/shinyjs/) | shinyjs - an R package |
166
186
  | [blabel.github.io](http://blabel.github.io) | Library for canonicalising blank node labels in RDF graphs |
@@ -171,7 +191,7 @@ Beautiful Jekyll has been used in over 500 websites in its first 6 months, and t
171
191
  | [terremotocentroitalia.info](https://www.terremotocentroitalia.info/) | Information about the 2016 Italy earthquake |
172
192
 
173
193
 
174
- ### Personal websites
194
+ ## Personal websites
175
195
 
176
196
  | Website | Who | What |
177
197
  | :------ |:--- | :--- |
@@ -187,13 +207,13 @@ Beautiful Jekyll has been used in over 500 websites in its first 6 months, and t
187
207
  | [ocram85.com](https://ocram85.com) | Marco Blessing | A personal blog about PowerShell and automation |
188
208
  | [khanna.cc](https://khanna.cc/) | Harry Khanna | Law and software |
189
209
 
190
- ## FAQ and support
210
+ # FAQ and support
191
211
 
192
212
  If you need any help, I suggest heading over to the [Jekyll support forum](https://talk.jekyllrb.com/).
193
213
 
194
214
  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.
195
215
 
196
- #### What if I don't want the website to be `https://<yourusername>.github.io`?
216
+ ### What if I don't want the website to be `https://<yourusername>.github.io`?
197
217
 
198
218
  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`.
199
219
 
@@ -201,38 +221,38 @@ If you want your project to be named something else, for example `MyAwesomeProje
201
221
 
202
222
  Now your website will be at `https://<yourusername>.github.io\MyAwesomeProject`.
203
223
 
204
- #### How do I change the number of posts per page OR the colour of the navigation bar OR the image in the navigation bar OR ...?
224
+ ### 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 ...?
205
225
 
206
226
  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.
207
227
 
208
- #### How do I add a favicon to my site?
228
+ ### How do I add a favicon to my site?
209
229
 
210
230
  Easy! Just place a valid `favicon.ico` in the root directory of your project. And then wait! It can take a while to update.
211
231
 
212
- #### How do I move the blog to another page instead of having it on the home page?
232
+ ### How do I move the blog to another page instead of having it on the home page?
213
233
 
214
234
  The default style of Beautiful Jekyll is to feature the blog feed on the front page. But for many sites that's not the ideal structure, and you may want to have a separate dedicated page for the blog posts. To have the blog hosted on a different URL (for example at `<mysite.com>/blog`), copy the `index.html` file into a folder with the same name as the desired page (for example, to `blog/index.html`), and in the `_config.yml` file you need to add a parameter `paginate_path: "/<page name>/page:num/"` (for example `paginate_path: "/blog/page:num/"`).
215
235
 
216
- #### What size do you recommend using for the `bigimg` photos?
236
+ ### What size do you recommend using for the `cover-img` photos?
217
237
 
218
238
  Unfortunately, this is a no-answer! There isn't a one-size-fits-all solution to this, because every person will view your site on a different browser with different dimensions. Some browsers will have very wide aspect ratio, some will be narrower, some will be vertical (such as phones), different phones have different screens, etc. The image will always be centered, so the only tip I can give is that you should make sure the important part of the image is in the middle so that it'll always show. Other than that, every browser will show a different clipping of the image.
219
239
 
220
- #### How do I use MathJax equations in my posts?
240
+ ### How do I use MathJax equations in my posts?
221
241
 
222
242
  MathJax can be easily integrated into your website with a one-line addition. You can see [this discussion](https://github.com/daattali/beautiful-jekyll/issues/195) for more information.
223
243
 
224
- ## Contributions
244
+ # Contributions
225
245
 
226
246
  Thank you to [all past contributors](https://github.com/daattali/beautiful-jekyll/graphs/contributors). If you find any problems or would like to contribute in any way, feel free to create a pull request/open an issue/send me a message. Any comments are welcome!
227
247
 
228
248
  You can also contribute by becoming an [official sponsor](https://github.com/sponsors/daattali) to help keep beautiful-jekyll well-maintained.
229
249
 
230
- ## Credits
250
+ # Credits
231
251
 
232
252
  This template was not made *entirely* from scratch. I'd like to give special thanks to [Jekyll Now](https://github.com/barryclark/jekyll-now) and [Bootstrap Clean Blog](https://github.com/IronSummitMedia/startbootstrap-clean-blog), from whom I've taken several ideas initially.
233
253
 
234
254
  I'd also like to thank [Dr. Jekyll's Themes](https://drjekyllthemes.github.io/), [Jekyll Themes](http://jekyllthemes.org/), and another [Jekyll Themes](http://jekyllrc.github.io/jekyllthemes/) for featuring Beautiful Jekyll in their Jekyll theme directories.
235
255
 
236
- ## Known limitations
256
+ # Known limitations
237
257
 
238
258
  - 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.
@@ -1,19 +1,19 @@
1
1
  {%- if site.disqus -%}
2
2
  <div class="disqus-comments">
3
- <div class="comments">
3
+ <div class="comments">
4
4
  <div id="disqus_thread"></div>
5
5
  <script type="text/javascript">
6
- var disqus_shortname = '{{ site.disqus }}';
7
- /* ensure that pages with query string get the same discussion */
8
- var url_parts = window.location.href.split("?");
9
- var disqus_url = url_parts[0];
10
- (function() {
11
- var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
12
- dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
13
- (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
14
- })();
6
+ var disqus_shortname = '{{ site.disqus }}';
7
+ /* ensure that pages with query string get the same discussion */
8
+ var url_parts = window.location.href.split("?");
9
+ var disqus_url = url_parts[0];
10
+ (function() {
11
+ var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
12
+ dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
13
+ (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
14
+ })();
15
15
  </script>
16
16
  <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
17
- </div>
17
+ </div>
18
18
  </div>
19
19
  {%- endif -%}
@@ -1,7 +1,7 @@
1
1
  {% if include.css.sri %}
2
2
  <link href="{{ include.css.href }}" rel="stylesheet" integrity="{{ include.css.sri }}" crossorigin="anonymous">
3
3
  {% elsif include.css.href %}
4
- <link rel="stylesheet" href="{{ include.css.href }}" />
4
+ <link rel="stylesheet" href="{{ include.css.href }}">
5
5
  {% else %}
6
- <link rel="stylesheet" href="{{ include.css }}" />
6
+ <link rel="stylesheet" href="{{ include.css }}">
7
7
  {% endif %}
@@ -1,14 +1,16 @@
1
1
  {%- if site.fb_comment_id -%}
2
2
  <div class="comments">
3
- <div id="fb-root"></div>
4
- <script>(function(d, s, id) {
5
- var js, fjs = d.getElementsByTagName(s)[0];
6
- if (d.getElementById(id)) return;
7
- js = d.createElement(s); js.id = id;
8
- js.src = 'https://connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.12&appId={{ site.fb_comment_id }}&autoLogAppEvents=1';
9
- fjs.parentNode.insertBefore(js, fjs);
10
- }(document, 'script', 'facebook-jssdk'));</script>
11
- <div class="fb-comments" data-href="{{ page.url | absolute_url }}" data-width="100%" data-numposts="5"></div>
12
- <noscript>Please enable JavaScript to view the comments powered by Facebook.</noscript>
3
+ <div id="fb-root"></div>
4
+ <script>
5
+ (function(d, s, id) {
6
+ var js, fjs = d.getElementsByTagName(s)[0];
7
+ if (d.getElementById(id)) return;
8
+ js = d.createElement(s); js.id = id;
9
+ js.src = 'https://connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.12&appId={{ site.fb_comment_id }}&autoLogAppEvents=1';
10
+ fjs.parentNode.insertBefore(js, fjs);
11
+ }(document, 'script', 'facebook-jssdk'));
12
+ </script>
13
+ <div class="fb-comments" data-href="{{ page.url | absolute_url }}" data-width="100%" data-numposts="5"></div>
14
+ <noscript>Please enable JavaScript to view the comments powered by Facebook.</noscript>
13
15
  </div>
14
16
  {%- endif -%}
@@ -1,18 +1,18 @@
1
1
  <footer class="footer-min">
2
2
  <div class="text-muted">
3
- {% if site.author %}
4
- {{ site.author }}
5
- &nbsp;&nbsp;&bull;&nbsp;&nbsp;
6
- {% endif %}
7
- {% if page.date %}
8
- {{ page.date }}
9
- {% else %}
10
- {{ site.time | date: '%Y' }}
11
- {% endif %}
3
+ {% if site.author %}
4
+ {{ site.author }}
5
+ &nbsp;&nbsp;&bull;&nbsp;&nbsp;
6
+ {% endif %}
7
+ {% if page.date %}
8
+ {{ page.date }}
9
+ {% else %}
10
+ {{ site.time | date: '%Y' }}
11
+ {% endif %}
12
12
 
13
13
  {% if site.url-pretty %}
14
- &nbsp;&nbsp;&bull;&nbsp;&nbsp;
15
- <a href="{{ '' | absolute_url }}">{{ site.url-pretty }}</a>
14
+ &nbsp;&nbsp;&bull;&nbsp;&nbsp;
15
+ <a href="{{ '' | absolute_url }}">{{ site.url-pretty }}</a>
16
16
  {% endif %}
17
17
  </div>
18
18
  </footer>
@@ -9,9 +9,9 @@
9
9
  <!-- doing something a bit funky here because I want to be careful not to include JQuery twice! -->
10
10
  {% if js contains 'jquery' %}
11
11
  <script>
12
- if (typeof jQuery == 'undefined') {
12
+ if (typeof jQuery == 'undefined') {
13
13
  document.write('<script src="{{ js | relative_url }}"></scr' + 'ipt>');
14
- }
14
+ }
15
15
  </script>
16
16
  {% else %}
17
17
  <script src="{{ js | relative_url }}"></script>
@@ -1,7 +1,7 @@
1
1
  <footer>
2
- <div class="container beautiful-jekyll-footer">
2
+ <div class="container-md beautiful-jekyll-footer">
3
3
  <div class="row">
4
- <div class="col-lg-8 col-lg-offset-2 col-md-10 col-md-offset-1">
4
+ <div class="col-xl-8 offset-xl-2 col-lg-10 offset-lg-1">
5
5
  {% include social-networks-links.html %}
6
6
  {% if page.footer-extra %}
7
7
  <div class="footer-custom-content">
@@ -10,14 +10,14 @@
10
10
  {% endif %}
11
11
  <p class="copyright text-muted">
12
12
  {% if site.author %}
13
- {{ site.author }}
14
- &nbsp;&bull;&nbsp;
13
+ {{ site.author }}
14
+ &nbsp;&bull;&nbsp;
15
15
  {% endif %}
16
16
  {{ site.time | date: '%Y' }}
17
17
 
18
18
  {% if site.url-pretty %}
19
- &nbsp;&bull;&nbsp;
20
- <a href="{{ '' | absolute_url }}">{{ site.url-pretty }}</a>
19
+ &nbsp;&bull;&nbsp;
20
+ <a href="{{ '' | absolute_url }}">{{ site.url-pretty }}</a>
21
21
  {% endif %}
22
22
 
23
23
  {% if site.matomo %}
@@ -1,14 +1,14 @@
1
1
  {% if site.google_analytics %}
2
2
  <!-- Google Analytics -->
3
3
  <script>
4
- (function (i, s, o, g, r, a, m) {
5
- i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
6
- (i[r].q = i[r].q || []).push(arguments)
7
- }, i[r].l = 1 * new Date(); a = s.createElement(o),
8
- m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
9
- })(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga');
10
- ga('create', '{{ site.google_analytics }}', 'auto');
11
- ga('send', 'pageview');
4
+ (function (i, s, o, g, r, a, m) {
5
+ i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
6
+ (i[r].q = i[r].q || []).push(arguments)
7
+ }, i[r].l = 1 * new Date(); a = s.createElement(o),
8
+ m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
9
+ })(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga');
10
+ ga('create', '{{ site.google_analytics }}', 'auto');
11
+ ga('send', 'pageview');
12
12
  </script>
13
13
  <!-- End Google Analytics -->
14
14
  {% endif %}