90 Commits
4.1.0 ... 5.0.0

Author SHA1 Message Date
d5859860e3 bump version to 5.0.0 2020-09-15 22:16:19 +00:00
ff02b9d80f add top margin to headers 2020-09-15 17:29:27 -04:00
de46c033b6 Update README.md 2020-09-15 17:16:52 -04:00
fc31bea5ce Update README.md 2020-09-15 17:16:21 -04:00
f9324ff166 link to faq 2020-09-15 16:02:03 -04:00
36437dc4bd Update README.md 2020-09-15 02:26:30 -04:00
663d45190e Update README.md 2020-09-14 02:24:31 -04:00
bdfcca0f5e Update README.md 2020-09-14 02:22:49 -04:00
051413d0dc Update README.md 2020-09-14 02:21:08 -04:00
71d494ca89 Update README.md 2020-09-14 02:20:52 -04:00
7268d4fa21 make thumbnails square 2020-09-13 07:37:29 +00:00
807f35ff05 allow url-canonical in footer 2020-09-12 21:07:08 -04:00
f64281de36 convert px to rem for tags border 2020-09-12 21:01:19 -04:00
12c5c85584 code chunks css: fix line height 2020-09-12 20:35:13 -04:00
253bad1a95 Update README.md 2020-09-12 18:33:18 -04:00
d57097a1fe add last-updated YAML parameter 2020-09-12 22:30:43 +00:00
9827abc40e make tags less visually strong 2020-09-12 21:35:44 +00:00
bb7ddee453 make code chunks backgruodn slightly darker 2020-09-12 14:26:35 -04:00
6d6d876874 make code chunks background a little lighter 2020-09-12 14:25:38 -04:00
0eac10c664 make code chunks a little smaller 2020-09-12 14:20:56 -04:00
8af3d917d7 remove custom.css since there's already a site-css setting 2020-09-12 13:05:22 -04:00
53cf8f01db add site-js setting 2020-09-12 16:59:47 +00:00
2128b1c48b remove tab 2020-09-12 06:08:43 +00:00
205961a7bb rewrite CHANGELOG 2020-09-12 04:37:48 +00:00
03105db2f0 add custom.css template to make it easier for users to add their own CSS 2020-09-12 03:59:24 +00:00
0222ebfad5 Update issue_template.md 2020-09-10 21:52:31 -04:00
34a9017ffe add version to HTML 2020-09-06 14:02:04 -04:00
5986596714 navbar css: make text size and spacing IDENTICAL to pre bootstrap 4 upgrade 2020-09-04 23:30:54 +00:00
e2a0826459 Update footer.html 2020-09-04 01:22:09 -04:00
a67d05c550 Update footer.html 2020-09-04 01:17:17 -04:00
41c9cd93de add intro comment in config 2020-09-04 00:52:20 -04:00
f362b7dec2 use kramdown 2.3.0; fixes #713 2020-09-01 05:56:08 +00:00
b492d72764 add feed_show_tags option 2020-09-01 05:48:24 +00:00
a0b2ccee84 css: rearrange some of the file and add a few styles from before bootstrap upgrade; fixes #716 2020-09-01 04:33:08 +00:00
8d081663ed css: make inline code look the same as before bootstrap 4 upgrade 2020-09-01 04:05:27 +00:00
86b9f8236c fix nav-short option to have short avatar and to not have top whitespace 2020-08-31 17:46:42 +00:00
5068c2de8d make show-avatar default for everyone (fixes #715) 2020-08-31 17:08:28 +00:00
7d784b37c8 add config option 'feed_show_excerpt 2020-08-30 07:25:36 +00:00
fcddc9e561 add YAML options before-content and after-content 2020-08-24 22:04:22 +00:00
d88e0468c2 use proper capitalization in demo post 2020-08-24 21:25:05 +00:00
b660fef759 support multiple files in footer-extra and head-extra 2020-08-24 20:43:43 +00:00
c677c7e114 change default timezone to east coast 2020-08-23 22:25:58 -04:00
a852782853 Update README.md 2020-08-23 21:48:01 -04:00
499ebb8461 Update README.md 2020-08-23 21:43:44 -04:00
c269ad6a2c readme: add information about upgrading to newer versions 2020-08-23 21:35:02 -04:00
20ab6aa941 Update README.md 2020-08-23 20:42:01 -04:00
30d2e141d8 accidentally reverted some of the README 2020-08-24 00:39:52 +00:00
8438f3dbe2 add note about sometimes having to re-trigger build; fixes #710 2020-08-24 00:37:54 +00:00
5991966d38 upgrade to jquery 3.5.1 2020-08-24 00:17:44 +00:00
fbc6b0bd6d add aria label to link for accessibility 2020-08-23 22:29:14 +00:00
ee8099fa6e add alt text to changelog 2020-08-23 22:22:46 +00:00
1db4dd96fa ensure all images have alt text 2020-08-23 22:21:47 +00:00
43d79b6dc9 remove link-tags settings 2020-08-23 22:19:15 +00:00
f65e439025 add full-width YAML option 2020-08-23 19:23:33 +00:00
909190a415 Update CHANGELOG.md 2020-08-23 04:32:56 -04:00
53242003b0 Update CHANGELOG.md 2020-08-23 04:31:44 -04:00
d5031ed015 Update README.md 2020-08-23 04:11:45 -04:00
2e3c779e9e Update README.md 2020-08-23 04:10:11 -04:00
a8eea6ce3a Update README.md 2020-08-23 04:09:49 -04:00
6a1b3cb343 redesign seo/social media sharing parameters 2020-08-23 07:09:44 +00:00
71a59841a0 improve README 2020-08-23 04:04:56 +00:00
3ea3d52dbd small updates to config file params documentation 2020-08-22 23:44:19 +00:00
6c007bd4bf fix small issue with site social share description 2020-08-22 08:43:04 +00:00
efe3a22f1f refactor head tag to use variables 2020-08-22 08:40:57 +00:00
a04d8bb1b6 when determining navbar colour, add a small delay to make sure it was painted 2020-08-21 23:05:37 -04:00
b76c4fa1b3 rename css/js files from 'main' to 'beautifuljekyll' 2020-08-21 18:55:52 +00:00
6ba7b4e325 Update README.md 2020-08-21 14:15:28 -04:00
0577b83b7e Update footer.html 2020-08-21 12:38:18 -04:00
9a2c965082 Update footer.html 2020-08-21 12:34:20 -04:00
ff74e9e8ee Update footer.html 2020-08-21 12:32:22 -04:00
37e9026549 Update footer.html 2020-08-21 12:31:37 -04:00
095ec34ca9 Update README.md 2020-08-21 03:08:03 -04:00
59a8feb1e4 Update CHANGELOG.md 2020-08-21 02:51:27 -04:00
e7bcc18e07 Update README.md 2020-08-21 02:46:13 -04:00
94feff3bc2 Update CHANGELOG.md 2020-08-19 23:21:56 -04:00
b5826fea49 include site-wide css files before page-specific css 2020-08-19 23:19:54 -04:00
4c62c42955 Update README.md 2020-08-19 15:47:12 -04:00
2134efd758 Update CHANGELOG.md 2020-08-16 18:48:10 -04:00
22804f1ca8 change footer and navbar background to darker 2020-08-16 18:33:22 -04:00
79fa638686 change footer and header grey to slightly darker for more contrast 2020-08-16 18:16:19 -04:00
c7c5ba0207 Automatically set navbar light/dark based on color (#702) 2020-08-15 11:41:28 -04:00
5ce0f3a5f2 Update CHANGELOG.md 2020-08-08 21:47:38 -04:00
18714c756b update readme to document head-extra param 2020-08-08 21:46:29 -04:00
7f45ae2618 support head-extra 2020-08-08 21:44:57 -04:00
4c319e6aba Update README.md 2020-08-08 21:43:14 -04:00
29381b1992 Cleans up trailing whitespace (#700) 2020-08-08 20:13:28 -04:00
67848364f3 meta description: use site description if page one is not provided 2020-08-08 18:32:36 -04:00
3579b04705 Update README.md 2020-08-08 14:09:59 -04:00
3d925bd086 Update README.md 2020-08-08 14:09:10 -04:00
12974e60ff Update CHANGELOG.md 2020-08-08 14:08:27 -04:00
30 changed files with 672 additions and 501 deletions

View File

@ -1 +1,3 @@
Please only submit feature suggestions or bug reports if you believe something is broken. Please do not submit support requests and general help questions.
If you enjoy Beautiful Jekyll, please consider supporting the theme! https://beautifuljekyll.com/plans/

View File

@ -9,5 +9,5 @@ permalink: /404.html
<h1>Move along. (404 error)</h1>
<br/>
<img src="{{ 'assets/img/404-southpark.jpg' | relative_url }}" />
<img src="{{ 'assets/img/404-southpark.jpg' | relative_url }}" alt="Not found" />
</div>

View File

@ -1,60 +1,106 @@
## v4.1.0 2020-08-08
## v5.0.0 (2020-09-15)
- Add Open Graph `site_name` field
- Add `text-col `config setting for main text color (#694)
- Add `keywords` config setting to set the meta keywords on all pages (for SEO purposes) (#691)
- Add `mobile-theme-col` config setting to allow a mobile theme colour (#692)
- Add `site-css` config setting in the config file to provide CSS files that are used on all pages in the site (#695)
- Add YAML option `description`: creates the meta description on a page, intended to provide a brief description of the page for search engines and when the page is shared (#690)
One of the major changes in this version is that a lot of time was spent on rethinking the entire SEO and social media sharing model (how a page looks on eg. Google, Twitter, Facebok). It was redesigned to be more simple and customizable. The new documentation has a section dedicated to SEO and social media sharing of a page. Unfortunately some changes that are not backwards-compatible had to be made.
## v4.0.1 2020-07-13
#### Breaking changes
- Renamed `description` YAML parameter to `share-description` to be more clear
- Renamed `description` config setting to `rss-description` since it was only used in RSS (the FAQ explains the difference between YAML parameters and config settings if you're confused)
- Removed YAML parameter `use-site-title` (you can now specify the exact title using `share-title`)
- Removed undocumented YAML parameters `meta-title` and `meta-description`
- Removed `link-tags` config setting because it wasn't necessary. If you use tags, there will now always be a tags page created; if you don't use tags there won't be a tags page.
- The YAML parameter `show-avatar` is now true by default. This has always been the case for GitHub Pages users, but not for `remote_theme` users. For consistency, it's now the default for everyone. (#715)
#### New parameters and settings
- Added `full-width` YAML parameter to allow having full-width pages
- Added `feed_show_excerpt` config setting to show/hide the post excerpts on the feed page
- Added `feed_show_tags` config setting to show/hide the list of tags on post previews on the feed page
- Added `share-title` YAML parameter to give control over the search engine/social media title
- Added `last-updated` YAML parameter to show a "Last Updated on" date for blog posts
- Added `before-content` and `after-content` YAML parameters that allow you to add some common HTML before the main content of a page (below the title) or after the main content (above the footer). Works in a similar way to `footer-extra`.
- Added `head-extra` YAML parameter which is similar to `footer-extra` but is used to include custom HTML code in a page's `<head>` tag
- Added `site-js` config setting to provide JavaScript files that are used on all pages in the site
#### New features and improvements
- Improved the `footer-extra` YAML parameter to support multiple files instead of only a single file
- Added automatic navbar color detection (#702)
- When `nav-short` is turned on, the avatar will also be shorter
- Changed navbar and footer background colour to be slightly darker, for better contrast with the default white page background for accessibility reasons
- Changed the behaviour of `site-css` to include site-wide CSS file **before** instead of after page-specific files
- Renamed internal css/js files from "main" to "beautifuljekyll" to make it easier for users to troubleshoot
- Added alt text to all images for better accessibility
- Made thumbnail images square instead of circles, as users reported that circles cut off important parts of images
#### Bug fixes
- Fixed rendering issues with `nav-short` parameter that caused the body of the page to start too low
- Fixed some CSS styles that broke during the bootstrap 4 migration (#716)
#### Library upgrades
- Upgraded kramdown to version 2.3.0 to fix security issues
- Upgraded jQuery to version 3.5.1 to fix a couple security vulnerabilities with the previous version
## v4.1.0 (2020-08-08)
- Added Open Graph `site_name` meta field to pages automatically
- Added `text-col` config setting for main text color (#694)
- Added `keywords` config setting to set the meta keywords on all pages (for SEO purposes) (#691)
- Added `mobile-theme-col` config setting to allow a mobile theme colour (#692)
- Added `site-css` config setting in the config file to provide CSS files that are used on all pages in the site (#695)
- Added YAML parameter `description`: creates the meta description on a page, intended to provide a brief description of the page for search engines and when the page is shared (#690)
## v4.0.1 (2020-07-13)
- Fixed staticman comments UI that was broken since the migration to bootstrap 4
## v4.0.0 2020-07-12
## v4.0.0 (2020-07-12)
- **BREAKING CHANGE** Replace `image` YAML parameter with `thumbnail-img` to be more clear
- **MAJOR BEHAVIOUR CHANGE** Don't use the thumbnail as the avatar image
- **MAJOR BEHAVIOUR CHANGE** Don't use the thumbnail as the avatar image
- Cover image will automatically be used as thumbnail if none is provided
- Image to share on social media will use the cover image or thumbnail if none is provided
- All images (social media share, thumbnail, cover) can use either relative or absoluate paths.
- Fixed issue where if a dropdown menu was the last item in the menu bar, it did not have a proper margin on the right
- Add social network links: Mastodon (#646), Google Scholar, ORCID (#670)
- Add support for sharing pages on new social network: VK (#657)
- Added social network links: Mastodon (#646), Google Scholar, ORCID (#670)
- Added support for sharing pages on new social network: VK (#657)
- Use Open Graph type 'article' for blog posts (#669)
- Use Twitter's large sumary card (large image) when there is a cover image, thumbnail image, or share image specified (#668)
- Make post images in the feed page smaller on smaller devices
- Made post images in the feed page smaller on smaller devices
- Fixed jQuery version in staticman (#671)
## v3.0.0 2020-05-07
## v3.0.0 (2020-05-07)
- **BREAKING CHANGE** Upgraded from Bootstrap 3.3.2 to 4.4.1. This involved a major rewrite of most components. This shouldn't affect any users unless you have custom HTML/CSS code which the new Bootstrap could have broken.
- **BREAKING CHANGE** Renamed `bigimg` YAML parameter to `cover-img`
- **BREAKING CHANGE** Removed `googlefonts` YAML parameter since googlefonts are just CSS so they can be loaded via `ext-css`
- **BREAKING CHANGE** Upgraded from jQuery 1.11.2 to 3.4.2. This should not affect most people
- Added `navbar-border-col` setting in the config file
- Add accessibility features where possible
- Added accessibility features where possible
- Made the theme completely responsive by rewriting all CSS to use 'rem' instead of 'px'
- Rewrite and simplify some JavaScript code to use CSS or Bootstrap alternatives that weren't available in 2015
- Remove most of the sample posts so that users only have two sample posts to learn from
- Rewrote and simplified some JavaScript code to use CSS or Bootstrap alternatives that weren't available in 2015
- Removed most of the sample posts so that users only have two sample posts to learn from
- Improvements to the README instructions
## v2.3.0 2020-04-29
## v2.3.0 (2020-04-29)
- Add YAML option `footer-extra` for including custom content in the footer
- Fix issue: linking to a specific part of a page resulted in scrolling too far (#69)
- Add YAML option `nav-short` to have navbar permanently collapsed
- Add social network link: Calendly
- Fix bug where RSS link in footer was showing even when turned off
- Added YAML parameter `footer-extra` for including custom content in the footer
- Fixed issue: linking to a specific part of a page resulted in scrolling too far (#69)
- Added YAML parameter `nav-short` to have navbar permanently collapsed
- Added social network link: Calendly
- Fixed bug where RSS link in footer was showing even when turned off
## v2.2.0 2020-04-27
## v2.2.0 (2020-04-27)
- Add social network link: Telegram (#625) (thanks @mashed-potatoes)
- Moved the demo site to an independent URL: https://beautifuljekyll.com
- Major documentation overhaul and cleanup of old files
- Fix a few bugs from the remote_theme migration
- Added social network link: Telegram (#625) (thanks @mashed-potatoes)
- Moved the demo site to an independent URL: https://beautifuljekyll.com
- Major documentation overhaul and cleanup of old files
- Fixed a few bugs from the remote_theme migration
## v2.0.0 2020-04-26
## v2.0.0 (2020-04-26)
- Beautiful-Jekyll v2.0.0 available as an official Ruby gem
- Beautifull-Jekyll now supports the `remote_theme` config (#339) (thanks @gpotter2 and @skalee)

197
README.md
View File

@ -1,52 +1,51 @@
[![](https://i.imgur.com/zNBkzj1.png)](https://xscode.com/daattali/beautiful-jekyll)
[![](https://i.imgur.com/zNBkzj1.png)](https://beautifuljekyll.com/plans/)
# Beautiful Jekyll
[![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)
[![Gem Version](https://badge.fury.io/rb/beautiful-jekyll-theme.svg)](https://badge.fury.io/rb/beautiful-jekyll-theme)
> *Created by [Dean Attali](https://deanattali.com)* &middot; [Demo](https://beautifuljekyll.com/)
> By [Dean Attali](https://deanattali.com) &middot; [Demo](https://beautifuljekyll.com/)
**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).
**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.
**If you enjoy this theme, please consider [supporting me](https://github.com/sponsors/daattali) for developing and maintaining it for over 5 years.**
<p align="center">
<a style="display: inline-block;" href="https://github.com/sponsors/daattali">
<img height="40" src="https://i.imgur.com/034B8vq.png" />
</a>
&nbsp;&nbsp;
<a style="display: inline-block;" href="https://paypal.me/daattali">
<img height="40" src="https://camo.githubusercontent.com/0e9e5cac101f7093336b4589c380ab5dcfdcbab0/68747470733a2f2f63646e2e6a7364656c6976722e6e65742f67682f74776f6c66736f6e2f70617970616c2d6769746875622d627574746f6e40312e302e302f646973742f627574746f6e2e737667" />
</a>
</p>
**If you enjoy Beautiful Jekyll, please consider [supporting me](https://github.com/sponsors/daattali) for over 5 years of development (and to unlock rewards!) ❤**
## Table of contents
- [Features](#features)
- [Sponsors 🏆](#sponsors)
- [**Build your website in 3 steps**](#build-your-website-in-3-steps)
- [Plans](#plans)
- [Add your own content](#add-your-own-content)
- [Customizing parameters for each page](#customizing-parameters-for-each-page)
- [Supported parameters](#supported-parameters)
- [Showcased users (success stories!)](#showcased-users-success-stories)
- [Featured users (success stories!)](#featured-users-success-stories)
- [FAQ and support](#faq-and-support)
- [Credits and contributions](#credits)
# Features
Check out [*What's New?*](https://beautifuljekyll.com/updates/) to see the latest features.
- **SIMPLE**: The primary goal of Beautiful Jekyll is to allow literally *anyone* to create a website in a few minutes.
- **Modern**: Uses the latest best practices and technologies to achieve nearly perfect scores on Google Chrome's Audit.
- **Mobile-first**: Designed to look great on both large-screen and small-screen (mobile) devices.
- **Highly customizable**: Many personalization settings such as changing the background colour/image, adding a logo.
- **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.
- **Battle-tested**: By using Beautiful Jekyll, you'll be joining tens of thousands of users who used this theme since 2015.
- **Links to your social media**: You can easily add links to any of your social media accounts in the footer of every page.
- **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).
- **Share blog posts on social media**: By default, all blog posts have buttons to allow people to share on Twitter/Facebook/LinkedIn.
- **Modern**: Uses the latest best practices and technologies to achieve nearly perfect scores on Google Chrome's Audit.
- **Mobile-first**: Designed to look great on both large-screen and small-screen (mobile) devices.
- **Highly customizable**: Many personalization settings such as changing the background colour/image, adding a logo.
- **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.
- **Battle-tested**: By using Beautiful Jekyll, you'll be joining 50,000+ users enjoying this theme since 2015.
- **SEO and social media support**: Customize how your site looks on Google and when shared on social media.
- **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).
- **Tags**: Any blog post can be tagged with keywords, and an index page showing all the tags is automatically generated.
- **Tracking analytics**: Easily integrate Google Analytics, or other analytics platforms, to track visits to your website.
- **Photos support**: Any page can have a cover photo around its title, and any blog post can have an associated image.
- **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.
- **Analytics**: Easily integrate Google Analytics, or other analytics platforms, to track visits to your website.
- **Photos support**: Any page can have a full-width cover photo and thumbnail.
- **RSS**: An RSS feed is automatically created, so you can even host a podcast easily with Beautiful Jekyll.
<h2 id="sponsors">Sponsors 🏆</h2>
> There are no sponsors yet
[Become the first sponsor for Beautiful Jekyll and unlock special rewards\!](https://github.com/sponsors/daattali/sponsorships?tier_id=39856)
# Build your website in 3 steps
@ -66,45 +65,51 @@ Fork this project by clicking the __*Fork*__ button at the top right corner of t
### 2. Rename the project to `<yourusername>.github.io`
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.
Click on __*Settings*__ at the top (the cog icon) and on that page you'll have an option to rename the project (*Repository name*). This will create a website with the **Beautiful Jekyll** template that will be available at `https://<yourusername>.github.io` within a couple minutes (check out the [FAQ](https://beautifuljekyll.com/faq/#custom-domain) if you want to use a different project name). If after a few minutes your website is still not ready, try making any edit to any file, just to force GitHub to re-build your site.
### 3. Customize your website settings
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.
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!**
### 4. Congratulations! You have a website!
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.
After you save your changes to the `_config.yml` file (by clicking on *Commit changes* as the video tutorial shows), your website should be ready in a minute or two at `https://<yourusername>.github.io`. Every time you make a change to any file, your website will get rebuilt and should be updated in about a minute or so. Your website will be initialized with several sample blog posts and a couple other pages.
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 :)**
Note that this was the easy way to *create* your website, but it does come at a cost: when Beautiful Jekyll gains new features in the future, *updating* your website to include all the latest features is cumbersome. See the [FAQ](https://beautifuljekyll.com/faq/#updating) for help with upgrading in the future.
## The hard way (using ruby gems)
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).
If you followed the easy method above, then you already have your site and you can skip this section! If you want to use Beautiful Jekyll as a ruby gem instead, follow the [advanced installation instructions](https://beautifuljekyll.com/getstarted/#install-steps-hard). This is harder to set up initially, but it makes it super easy to keep your site up to date with Beautiful Jekyll when more features are added in the future.
# Plans
Beautiful Jekyll is, and always will be, free. But if you want to remove the Beautiful Jekyll ad from your website, use a Dark Mode skin, unlock other special rewards, or simply support my development efforts, [check out the different plans](https://beautifuljekyll.com/plans).
# Add your own content
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.
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).
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!
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!
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.
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`.
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`.
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.
# Customizing parameters for each page
**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:
**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**:
```
---
---
```
If you do want to use any parameters, write them between these two lines. For example, you can have this at the top of a page:
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:
```
---
@ -113,15 +118,15 @@ subtitle: Here you'll find all the ways to get in touch with me
---
```
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.
You can look at the top of [`aboutme.md`](https://raw.githubusercontent.com/daattali/beautiful-jekyll/master/aboutme.md) as an example.
**Important takeaway: ALWAYS add the YAML front matter, which is two lines with three dashes, to EVERY page. If you have any parameters, they go between the two lines.**
If you don't include YAML then your file will not use this template.
**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.**
# Supported parameters
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.
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.
## Main parameters
@ -133,7 +138,18 @@ title | Page or blog post title
subtitle | Short description of page or blog post that goes under the title
tags | List of tags to categorize the post. Separate the tags with commas and place them inside square brackets. Example: `[personal, analysis, finance]`
cover-img | Include a large full-width image at the top of the page. You can either provide the path to a single image (eg. `"/path/to/img"`) , or a list of images to cycle through (eg. `["/path/img1", "/path/img2"]`). If you want to add a caption to an image, then the image should be provided as `{"/path/to/img" : "Caption of image"}`.
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`.
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.
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`.
## Parameters for SEO and social media sharing
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).
Parameter | Description
----------- | -----------
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.
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.
share-img | The image to show. If not provided, then `cover-img` or `thumbnail-img` will be used if one of them is provided.
## Less commonly used parameters
@ -143,14 +159,12 @@ Parameter | Description
----------- | -----------
readtime | If you want a post to show how many minutes it will take to read it, use `readtime: true`.
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`.
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.
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.
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`.
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`
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.
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`
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.
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.
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.
description | A brief description of the page (used in search engines and when the page is shared).
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.
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.
## Advanced parameters
@ -158,9 +172,12 @@ These are advanced parameters that are only useful for people who need very fine
Parameter | Description
----------- | -----------
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`)
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.
before-content | Similar to `footer-extra`, but used for including HTML before the main content of the page (below the title).
after-content | Similar to `footer-extra`, but used for including HTML after the main content of the page (above the footer).
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.
language | HTML language code to be set on the page's &lt;html&gt; element.
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`.
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.
js | List of local JavaScript files to include in the page (eg. `/assets/js/mypage.js`)
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="`
css | List of local CSS files to include in the page
@ -174,96 +191,28 @@ ext-css | List of external CSS files to include in the page. External CSS f
- **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.
- 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!
# Showcased users (success stories!)
# Featured users (success stories!)
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!
Visit the [Official website](http://beautifuljekyll.com/examples) to see sample websites using Beautiful Jekyll.
## Project/company websites
| Website | Description |
| :------ |:----------- |
| [repidemicsconsortium.org/](https://www.repidemicsconsortium.org/) | R Epidemics Consortium |
| [vaccineimpact.org](https://www.vaccineimpact.org/) | Vaccine Impact Modelling Consortium |
| [derekogle.com/fishR](http://derekogle.com/fishR/) | Using R for Fisheries Analyses |
| [joecks.github.io/clipboard-actions](http://joecks.github.io/clipboard-actions/) | Clipboard Actions - an Android app |
| [deanattali.com/shinyjs](http://deanattali.com/shinyjs/) | shinyjs - an R package |
| [blabel.github.io](http://blabel.github.io) | Library for canonicalising blank node labels in RDF graphs |
| [reactionic.github.io](http://reactionic.github.io) | Create iOS and Android apps with React and Ionic |
| [ja2-stracciatella.github.io](http://ja2-stracciatella.github.io) | Jagged Alliance 2 Stracciatella |
| [ddocent.com](http://ddocent.com/) | RADSeq Bioinformatics and Beyond |
| [guitarlessons.org](https://www.guitarlessons.org/) | Free online guitar lessons for all |
| [terremotocentroitalia.info](https://www.terremotocentroitalia.info/) | Information about the 2016 Italy earthquake |
## Personal websites
| Website | Who | What |
| :------ |:--- | :--- |
| [deanattali.com](https://deanattali.com) | Dean Attali | Creator of Beautiful Jekyll |
| [ouzor.github.io](http://ouzor.github.io) | Juuso Parkkinen | Data scientist |
| [derekogle.com](http://derekogle.com/) | Derek Ogle | Professor of Mathematical Sciences and Natural Resources |
| [melyanna.github.io](http://melyanna.github.io/) | Melyanna | Shows off her nice art |
| [chauff.github.io](http://chauff.github.io/) | Claudia Hauff | Professor at Delft University of Technology |
| [kootenpv.github.io](http://kootenpv.github.io/) | Pascal van Kooten | Data analytics |
| [sjackman.ca](http://sjackman.ca) | Shaun Jackman | PhD candidate in bioinformatics |
| [anudit.in](http://www.anudit.in/) | Anudit Verma | Engineering student |
| [sharepointoscar.github.io](http://sharepointoscar.github.io) | Oscar Medina | Independent Hacker |
| [ocram85.com](https://ocram85.com) | Marco Blessing | A personal blog about PowerShell and automation |
| [khanna.cc](https://khanna.cc/) | Harry Khanna | Law and software |
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!
# FAQ and support
If you need any help, I suggest heading over to the [Jekyll support forum](https://talk.jekyllrb.com/).
Visit the [official FAQ page](https://beautifuljekyll.com/faq) for answers to commonly asked questions.
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.
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/).
**If you really wany my personal help, please visit https://xscode.com/daattali/beautiful-jekyll to hire my services.**
- ### How do I add a favicon to my site?
Easy! Just place a valid `favicon.ico` in the root directory of your project. And then wait! It can take a while to update.
- ### 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 ...?
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.
- ### What if I want to use a custom domain for my site?
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).
- ### What if I want a free domain, but not `https://<yourusername>.github.io`?
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`.
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"!).
Now your website will be at `https://<yourusername>.github.io\MyAwesomeProject`.
- ### How do I move the blog to another page instead of having it on the home page?
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/"`).
- ### What size do you recommend using for the `cover-img` photos?
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.
- ### How do I use math equations in my posts?
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.
To receive support, select one of the [different plans](https://beautifuljekyll.com/plans) Beautiful Jekyll offers.
# Contributions
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!
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.
You can also contribute by becoming an [official sponsor](https://github.com/sponsors/daattali) to help keep beautiful-jekyll well-maintained.
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.
# Credits
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.
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.
# Known limitations
- 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.

View File

@ -1,10 +1,12 @@
# --- Basic options --- #
# Welcome to Beautiful Jekyll!
# This config file is meant for settings that affect your entire website. When you first
# set up your website you should go through all these settings and edit them, but after
# the initial set up you won't need to come back to this file often.
# --- Required options --- #
# Name of website
title: My website
# Short description of your site
description: A virtual proof that I'm awesome
title: My Website
# Your name to show in the footer
author: Some Person
@ -27,22 +29,20 @@ avatar: "/assets/img/avatar-icon.png"
# By default, the image is cut into a circle. You can disable this behaviour by setting 'round-avatar: false'
round-avatar: true
# If you want to have an image logo in the top-left corner instead of the title text,
# If you want to have an image logo in the top-left corner instead of having the title of the website,
# then specify the following parameter
#title-img: /path/to/image
# --- Footer options --- #
# --- Footer social media links --- #
# Select the social network links that you want to show in the footer.
# Uncomment the links you want to show and add your information to each one.
# If you don't want to show a link to an RSS feed, set rss to "false".
social-network-links:
email: "someone@example.com"
facebook: deanattali
github: daattali
twitter: daattali
rss: true
# reddit: yourname
# linkedin: daattali
# xing: yourname
@ -61,6 +61,10 @@ social-network-links:
# ORCID: your ORCID ID
# google-scholar: your google scholar
# If you want to show a link to an RSS in the footer, add the site description here.
# If you don't want to show an RSS link, remove the following line.
rss-description: This website is a virtual proof that I'm awesome
# --- General options --- #
# Select which social network share links to show in posts
@ -74,12 +78,15 @@ share-links-active:
# Remove this if you don't want a link in the footer
url-pretty: "MyWebsite.com"
# Create a "tags" index page and make tags on each post clickable
link-tags: true
# Excerpt Word Length - Truncates the excerpt to the specified number of words on the index page
# Excerpt word length - Truncate the excerpt of each post on the feed page to the specified number of words
excerpt_length: 50
# Whether or not to show an excerpt for every blog post in the feed page
feed_show_excerpt: true
# Whether or not to show a list of tags below each post preview in the feed page
feed_show_tags: true
# The keywords to associate with your website, for SEO purposes
#keywords: "my,list,of,keywords"
@ -87,18 +94,18 @@ excerpt_length: 50
# Personalize the colours in your website. Colour values can be any valid CSS colour
navbar-col: "#F5F5F5"
navbar-col: "#EAEAEA"
navbar-text-col: "#404040"
navbar-border-col: "#EAEAEA"
navbar-border-col: "#DDDDDD"
page-col: "#FFFFFF"
text-col: "#404040"
link-col: "#008AFF"
hover-col: "#0085A1"
footer-col: "#F5F5F5"
footer-col: "#EAEAEA"
footer-text-col: "#777777"
footer-link-col: "#404040"
# Alternatively, the navbar, footer, and page background can be set to use background images
# Alternatively, the navbar, footer, and page background can be set to an image
# instead of colour
#navbar-img: "/assets/img/bgimage.png"
@ -108,16 +115,20 @@ footer-link-col: "#404040"
# Suggest a colour for mobile browsers to use as the browser's theme. This is only supported by a few mobile browsers.
#mobile-theme-col: "#0085A1"
# For any extra customization, you can include additional CSS files in every page on your site
# For any extra visual customization, you can include additional CSS files in every page on your site. List any custom CSS files here
#site-css:
# - "/assets/css/custom-styles.css"
# --- Web Statistics Section --- #
# If you have common JavaScript files that should be included in every page, list them here
#site-js:
# - "/assets/js/custom-script.js"
# --- Web Analytics Section --- #
# Fill in your Google Analytics gtag.js ID to track your website using gtag
#gtag: ""
# Fill in your Google Analytics ID to track your website using GA
# Fill in your Google Analytics ID to track your website using Google Analytics
#google_analytics: ""
# Google Tag Manager ID
@ -158,28 +169,23 @@ footer-link-col: "#404040"
#staticman:
# repository : # GitHub username/repository eg. "daattali/beautiful-jekyll"
# branch : master # If you're not using `master` branch, then you also need to update the `branch` parameter in `staticman.yml`
# endpoint : # (optional) URL of your own deployment, with a trailing slash eg. https://<your-api>/v3/entry/github/ (will fallback to a public GitLab instance)
# endpoint : # (optional) URL of your own deployment, with a trailing slash eg. https://<your-api>/v3/entry/github/ (will fallback to a public GitLab instance)
# reCaptcha:
# siteKey : # Use your own site key, you need to apply for one on Google
# secret : # ENCRYPT your password by going to https://staticman3.herokuapp.com/v3/encrypt/<your-site-secret>
# --- Misc --- #
# Character used to separate site title and description in HTML document title
# and RSS feed title
title-separator: "-"
# Ruby Date Format to show dates of posts
date_format: "%B %-d, %Y"
# Facebook App ID
#fb_app_id: ""
# --- You don't need to touch anything below here (but you can if you want) --- #
# Output options (more information on Jekyll's site)
timezone: "America/Vancouver"
timezone: "America/Toronto"
markdown: kramdown
highlighter: rouge
permalink: /:year-:month-:day-:title/
@ -198,13 +204,11 @@ defaults:
layout: "post"
comments: true # add comments to all blog posts
social-share: true # add social media sharing buttons to all blog posts
readtime: false # add estimated reading time on all blog posts
-
scope:
path: "" # all files
path: "" # any file that's not a post will be a "page" layout by default
values:
layout: "page"
show-avatar: true
# Exclude these files from production site
exclude:

View File

@ -487,7 +487,7 @@ pa: &DEFAULT_PA
comment_success_msg : "ਤੁਹਾਡੀਆਂ ਟਿੱਪਣੀਆਂ ਲਈ ਧੰਨਵਾਦ! ਇਹ ਮਨਜ਼ੂਰੀ ਮਿਲਣ ਦੇ ਬਾਅਦ ਸਾਈਟ 'ਤੇ ਦਿਖਾਇਆ ਜਾਵੇਗਾ।"
comment_error_msg : "ਮੁਆਫ ਕਰਨਾ, ਤੁਹਾਡੀ ਅਧੀਨਗੀ ਵਿੱਚ ਕੋਈ ਗਲਤੀ ਹੋਈ ਸੀ ਕਿਰਪਾ ਕਰਕੇ ਯਕੀਨੀ ਬਣਾਓ ਕਿ ਸਾਰੇ ਲੋੜੀਂਦੇ ਖੇਤਰ ਪੂਰੇ ਹੋ ਗਏ ਹਨ ਅਤੇ ਦੁਬਾਰਾ ਕੋਸ਼ਿਸ਼ ਕਰੋ।"
pa-IN:
<<: *DEFAULT_PA
<<: *DEFAULT_PA
# Another locale
# --------------

View File

@ -1,6 +1,6 @@
{% if page.comments %}
{% if page.comments %}
{% include disqus.html %}
{% include fb-comment.html %}
{% include staticman-comments.html %}
{% include utterances-comment.html %}
{% endif %}
{% endif %}

View File

@ -19,6 +19,12 @@
{% endfor %}
{% endif %}
{% if site.site-js %}
{% for js in site.site-js %}
<script src="{{ js | relative_url }}"></script>
{% endfor %}
{% endif %}
{% if page.ext-js %}
{% for js in page.ext-js %}
{% include ext-js.html js=js %}

View File

@ -5,7 +5,9 @@
{% include social-networks-links.html %}
{% if page.footer-extra %}
<div class="footer-custom-content">
{% include {{ page.footer-extra }} %}
{% for file in page.footer-extra %}
{% include {{ file }} %}
{% endfor %}
</div>
{% endif %}
<p class="copyright text-muted">
@ -17,7 +19,9 @@
{% if site.url-pretty %}
&nbsp;&bull;&nbsp;
<a href="{{ '' | absolute_url }}">{{ site.url-pretty }}</a>
<span class="author-site">
<a href="{% if site.url-canonical %}{{ site.url-canonical }}{% else %}{{ '' | absolute_url }}{% endif %}">{{ site.url-pretty }}</a>
</span>
{% endif %}
{% if site.matomo %}
@ -28,10 +32,10 @@
{% endif%}
</p>
<!-- Please don't remove this, keep my open source work credited :) -->
<p class="theme-by text-muted">
Theme by
<a href="https://beautifuljekyll.com">beautiful-jekyll</a>
</p>
{% unless site.remove-ads %}<p class="theme-by text-muted">
Powered by
<a href="https://beautifuljekyll.com">Beautiful Jekyll</a>
</p>{% endunless %}
</div>
</div>
</div>

View File

@ -2,17 +2,34 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>{% if page.use-site-title %}{{ site.title }} {{ site.title-separator | default: '-' }} {{ site.description }}{% elsif page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
{% capture title %}
{%- if page.share-title -%}
{{ page.share-title }}
{%- elsif page.title -%}
{{ page.title }}
{%- else -%}
{{ site.title }}
{%- endif -%}
{% endcapture %}
{% capture description %}
{%- if page.share-description -%}
{{ page.share-description }}
{%- elsif page.subtitle -%}
{{ page.subtitle }}
{%- else -%}
{%- assign excerpt_length = site.excerpt_length | default: 50 -%}
{{ page.content | strip_html | xml_escape | truncatewords: excerpt_length | strip }}
{%- endif -%}
{% endcapture %}
<title>{{ title }}</title>
{% if site.author %}
<meta name="author" content="{{ site.author }}">
{% endif %}
{% if page.description %}
<meta name="description" content="{{ page.description }}">
{% elsif page.subtitle %}
<meta name="description" content="{{ page.subtitle }}">
{% endif %}
<meta name="description" content="{{ description }}">
{% if site.mobile-theme-col %}
<meta name="theme-color" content="{{ site.mobile-theme-col }}">
@ -22,7 +39,7 @@
<meta name="keywords" content="{{ site.keywords }}">
{% endif %}
<link rel="alternate" type="application/rss+xml" title="{{ site.title | default: 'Untitled' }} {{ site.title-separator | default: '-' }} {{ site.description }}" href="{{ '/feed.xml' | absolute_url }}">
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ '/feed.xml' | absolute_url }}">
{% include gtag.html %}
{% include gtm_head.html %}
@ -40,25 +57,24 @@
{% endfor %}
{% endif %}
{% if page.ext-css %}
{% for css in page.ext-css %}
{% include ext-css.html css=css %}
{% endfor %}
{% endif %}
{% if page.css %}
{% for css in page.css %}
<link rel="stylesheet" href="{{ css | relative_url }}">
{% endfor %}
{% endif %}
{% if site.site-css %}
{% for css in site.site-css %}
<link rel="stylesheet" href="{{ css | relative_url }}">
{% endfor %}
{% endif %}
<!-- Facebook OpenGraph tags -->
{% if page.ext-css %}
{% for css in page.ext-css %}
{% include ext-css.html css=css %}
{% endfor %}
{% endif %}
{% if page.css %}
{% for css in page.css %}
<link rel="stylesheet" href="{{ css | relative_url }}">
{% endfor %}
{% endif %}
{% if site.fb_app_id %}
<meta property="fb:app_id" content="{{ site.fb_app_id }}">
{% endif %}
@ -67,63 +83,43 @@
<meta property="og:site_name" content="{{ site.title }}">
{% endif %}
{% if page.meta-title %}
<meta property="og:title" content="{{ page.meta-title }}">
{% elsif page.title %}
<meta property="og:title" content="{{ page.title }}">
{% elsif site.title %}
<meta property="og:title" content="{{ site.title }}">
{% endif %}
{%- capture img -%}
{%- if page.share-img -%}
{{ page.share-img }}
{%- elsif page.cover-img -%}
{%- if page.cover-img.first -%}
{{ page.cover-img[0].first.first }}
{%- else -%}
{{ page.cover-img }}
{%- endif -%}
{%- elsif page.thumbnail-img -%}
{{ page.thumbnail-img }}
{%- elsif site.avatar -%}
{{ site.avatar }}
{% endif %}
{%- endcapture -%}
{%- assign img=img | strip -%}
{% if page.meta-description %}
<meta property="og:description" content="{{ page.meta-description }}">
{% elsif page.subtitle %}
<meta property="og:description" content="{{ page.subtitle }}">
{% else %}
<meta property="og:description" content="{{ page.content | strip_html | xml_escape | truncatewords: 50 }}">
{% endif %}
<meta property="og:title" content="{{ title }}">
<meta property="og:description" content="{{ description }}">
{% if img != "" %}
<meta property="og:image" content="{{ img | absolute_url }}">
{% endif %}
{% if page.id %}
<meta property="og:type" content="article">
<meta property="og:article:author" content="{{ site.author }}">
<meta property="og:article:published_time" content="{{ page.date | date_to_xmlschema }}">
{% else %}
<meta property="og:type" content="website">
{% endif %}
{% if page.id %}
<meta property="og:url" content="{{ page.url | absolute_url }}">
<link rel="canonical" href="{{ page.url | absolute_url }}">
{% else %}
<meta property="og:type" content="website">
<meta property="og:url" content="{{ page.url | absolute_url | strip_index }}">
<link rel="canonical" href="{{ page.url | absolute_url | strip_index }}">
{% endif %}
{%- capture shareimg -%}
{% if page.share-img %}
{{ page.share-img }}
{% elsif page.cover-img %}
{% if page.cover-img.first %}
{{ page.cover-img[0].first.first }}
{% else %}
{{ page.cover-img }}
{% endif %}
{% elsif page.thumbnail-img %}
{{ page.thumbnail-img }}
{% elsif site.avatar %}
{{ site.avatar }}
{% endif %}
{% endcapture %}
{% assign shareimg=shareimg | strip %}
{% if shareimg != "" %}
<meta property="og:image" content="{{ shareimg | absolute_url }}">
{% endif %}
<!-- Twitter summary cards -->
{% if shareimg != "" and shareimg != site.avatar %}
{% if img != "" and img != site.avatar %}
<meta name="twitter:card" content="summary_large_image">
{% else %}
<meta name="twitter:card" content="summary">
@ -131,33 +127,23 @@
<meta name="twitter:site" content="@{{ site.social-network-links.twitter }}">
<meta name="twitter:creator" content="@{{ site.social-network-links.twitter }}">
{% if page.meta-title %}
<meta name="twitter:title" content="{{ page.meta-title }}">
{% elsif page.title %}
<meta name="twitter:title" content="{{ page.title }}">
{% else %}
<meta name="twitter:title" content="{{ site.title }}">
<meta property="twitter:title" content="{{ title }}">
<meta property="twitter:description" content="{{ description }}">
{% if img != "" %}
<meta name="twitter:image" content="{{ img | absolute_url }}">
{% endif %}
{% if page.meta-description %}
<meta name="twitter:description" content="{{ page.meta-description }}">
{% elsif page.subtitle %}
<meta name="twitter:description" content="{{ page.subtitle }}">
{% else %}
<meta name="twitter:description" content="{{ page.content | strip_html | xml_escape | truncatewords: 50 }}">
{% endif %}
{% if shareimg != "" %}
<meta name="twitter:image" content="{{ shareimg | absolute_url }}">
{% endif %}
{% if site.matomo %}
{% include matomo.html %}
{% endif %}
{% if page.comments and site.staticman.repository and site.staticman.branch %}
<!-- Staticman -->
<link rel="stylesheet" href="{{ "/assets/css/staticman.css" | relative_url }}">
{% endif %}
{% if page.head-extra %}
{% for file in page.head-extra %}
{% include {{ file }} %}
{% endfor %}
{% endif %}
</head>

View File

@ -28,21 +28,27 @@
<div class="col-xl-8 offset-xl-2 col-lg-10 offset-lg-1">
<div class="{{ include.type }}-heading">
<h1>{% if page.title %}{{ page.title }}{% else %}<br/>{% endif %}</h1>
{% if page.subtitle %}
{% if include.type == "page" %}
<hr class="small">
<span class="{{ include.type }}-subheading">{{ page.subtitle }}</span>
{% else %}
<h2 class="{{ include.type }}-subheading">{{ page.subtitle }}</h2>
{% endif %}
{% endif %}
{% if include.type == "post" %}
<span class="post-meta">Posted on {{ page.date | date: date_format }}</span>
{% if page.readtime %}
{% include readtime.html %}
{% if page.subtitle %}
{% if include.type == "page" %}
<hr class="small">
<span class="{{ include.type }}-subheading">{{ page.subtitle }}</span>
{% else %}
<h2 class="{{ include.type }}-subheading">{{ page.subtitle }}</h2>
{% endif %}
{% endif %}
{% if include.type == "post" %}
<span class="post-meta">Posted on {{ page.date | date: date_format }}</span>
{% if page.last-updated %}
<span class="post-meta">
<span class="d-none d-md-inline middot">&middot;</span>
Last updated {{ page.last-updated | date: date_format }}
</span>
{% endif %}
{% if page.readtime %}
{% include readtime.html %}
{% endif %}
{% endif %}
{% endif %}
</div>
</div>
</div>
@ -56,21 +62,27 @@
<div class="col-xl-8 offset-xl-2 col-lg-10 offset-lg-1">
<div class="{{ include.type }}-heading">
<h1>{% if page.title %}{{ page.title }}{% else %}<br/>{% endif %}</h1>
{% if page.subtitle %}
{% if include.type == "page" %}
<hr class="small">
<span class="{{ include.type }}-subheading">{{ page.subtitle }}</span>
{% else %}
<h2 class="{{ include.type }}-subheading">{{ page.subtitle }}</h2>
{% endif %}
{% endif %}
{% if include.type == "post" %}
<span class="post-meta">Posted on {{ page.date | date: date_format }}</span>
{% if page.readtime %}
{% include readtime.html %}
{% if page.subtitle %}
{% if include.type == "page" %}
<hr class="small">
<span class="{{ include.type }}-subheading">{{ page.subtitle }}</span>
{% else %}
<h2 class="{{ include.type }}-subheading">{{ page.subtitle }}</h2>
{% endif %}
{% endif %}
{% if include.type == "post" %}
<span class="post-meta">Posted on {{ page.date | date: date_format }}</span>
{% if page.last-updated %}
<span class="post-meta">
<span class="d-none d-md-inline middot">&middot;</span>
Last updated {{ page.last-updated | date: date_format }}
</span>
{% endif %}
{% if page.readtime %}
{% include readtime.html %}
{% endif %}
{% endif %}
{% endif %}
</div>
</div>
</div>

View File

@ -1,4 +1,4 @@
<nav class="navbar navbar-expand-md navbar-light fixed-top navbar-custom {% if page.nav-short %}top-nav-short-permanent{% endif %}">
<nav class="navbar navbar-expand-md navbar-light fixed-top navbar-custom {% if page.nav-short %}top-nav-short-permanent{% else %}top-nav-regular{% endif %}">
{%- if site.title-img -%}
<a class="navbar-brand navbar-brand-logo" href="{{ '' | absolute_url }}"><img alt="{{ site.title }} Logo" src="{{ site.title-img }}"/></a>
@ -33,11 +33,11 @@
</ul>
</div>
{% if site.avatar and (layout.show-avatar or page.show-avatar) %}
{% if site.avatar and page.show-avatar != false %}
<div class="avatar-container">
<div class="avatar-img-border">
<a href="{{ '' | absolute_url }}">
<img alt="Navbar avatar" class="avatar-img" src="{{ site.avatar | relative_url }}" />
<img alt="Navigation bar avatar" class="avatar-img" src="{{ site.avatar | relative_url }}" />
</a>
</div>
</div>

View File

@ -6,10 +6,10 @@
{% assign number = finalReadTime | round %}
{% if number >= 1 %}
{% assign yesReadTime = number | append: " minute read" %}
<span class="reader-time post-meta"><span class="d-none d-md-inline middot">&middot;</span> {{ yesReadTime }}</span>
<span class="post-meta"><span class="d-none d-md-inline middot">&middot;</span> {{ yesReadTime }}</span>
{% elsif number < 1 %}
{% assign minReadTime = '&lt; 1 minute read' %}
<span class="reader-time post-meta"><span class="d-none d-md-inline middot">&middot;</span> {{ minReadTime }}</span>
<span class="post-meta"><span class="d-none d-md-inline middot">&middot;</span> {{ minReadTime }}</span>
{% else %}
{% assign nilReadTime = number | replace:'0',' ' %}
{{ nilReadTime }}

View File

@ -1,6 +1,6 @@
<ul class="list-inline text-center footer-links">
{%- if site.social-network-links.rss -%}
{%- if site.rss-description -%}
<li class="list-inline-item">
<a href="{{ '/feed.xml' | relative_url }}" title="RSS">
<span class="fa-stack fa-lg" aria-hidden="true">
@ -59,7 +59,7 @@
</a>
</li>
{%- endif -%}
{%- if site.social-network-links.github -%}
<li class="list-inline-item">
<a href="https://github.com/{{ site.social-network-links.github }}" title="GitHub">

View File

@ -75,7 +75,7 @@
<!-- doing something a bit funky here because I want to be careful not to include JQuery twice! -->
<script>
if (typeof jQuery == 'undefined') {
document.write('<script src="{{ "/assets/js/jquery-3.4.1.min.js" | relative_url }}"></scr' + 'ipt>');
document.write('<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js"></scr' + 'ipt>');
}
</script>
<script src="{{ "/assets/js/staticman.js" | relative_url }}"></script>

View File

@ -4,7 +4,7 @@
repo="{{ site.utterances.repository }}"
issue-term="{{ site.utterances.issue-term }}"
theme="{{ site.utterances.theme}}"
label="{{ site.utterances.label}}"
label="{{ site.utterances.label}}"
crossorigin="anonymous"
async>
</script>

View File

@ -1,7 +1,7 @@
---
common-css:
- "/assets/css/bootstrap-social.css"
- "/assets/css/main.css"
- "/assets/css/beautifuljekyll.css"
common-ext-css:
- href: "https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css"
sri: "sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh"
@ -9,32 +9,32 @@ common-ext-css:
- "https://fonts.googleapis.com/css?family=Lora:400,700,400italic,700italic"
- "https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800"
common-ext-js:
- href: "https://code.jquery.com/jquery-3.4.1.min.js"
sri: "sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo="
- href: "https://code.jquery.com/jquery-3.5.1.slim.min.js"
sri: "sha256-4+XzXVhsDmqanXGHaHvgh1gMQKX40OUvDEBTu8JcmNs="
- href: "https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js"
sri: "sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo"
- href: "https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/js/bootstrap.min.js"
sri: "sha384-wfSDF2E50Y2D1uUdj0O3uMBJnjuUD4Ih7YwaYd1iqfktj0Uod8GCExl3Og8ifwB6"
common-js:
- "/assets/js/main.js"
- "/assets/js/beautifuljekyll.js"
---
<!DOCTYPE html>
<html lang="{{ page.language | default: site.language | default: 'en' }}">
<!-- Beautiful Jekyll | MIT license | Copyright Dean Attali 2020 -->
{% include head.html %}
<!-- Beautiful Jekyll 5.0.0 | Copyright Dean Attali 2020 -->
{% include head.html %}
<body>
<body>
{% include gtm_body.html %}
{% include nav.html %}
{% include gtm_body.html %}
{{ content }}
{% include nav.html %}
{% include footer.html %}
{% include footer-scripts.html %}
</body>
{{ content }}
{% include footer.html %}
{% include footer-scripts.html %}
</body>
</html>

View File

@ -4,6 +4,22 @@ layout: base
<div class="intro-header"></div>
<div role="main" class="container-md">
<div role="main" class="{% if page.full-width %} container-fluid {% else %} container-md {% endif %}">
{% if page.before-content %}
<div class="before-content">
{% for file in page.before-content %}
{% include {{ file }} %}
{% endfor %}
</div>
{% endif %}
{{ content }}
{% if page.after-content %}
<div class="after-content">
{% for file in page.after-content %}
{% include {{ file }} %}
{% endfor %}
</div>
{% endif %}
</div>

View File

@ -9,6 +9,31 @@ layout: page
<div class="posts-list">
{% for post in posts %}
<article class="post-preview">
{%- capture thumbnail -%}
{% if post.thumbnail-img %}
{{ post.thumbnail-img }}
{% elsif post.cover-img %}
{% if post.cover-img.first %}
{{ post.cover-img[0].first.first }}
{% else %}
{{ post.cover-img }}
{% endif %}
{% else %}
{% endif %}
{% endcapture %}
{% assign thumbnail=thumbnail | strip %}
{% if site.feed_show_excerpt == false %}
{% if thumbnail != "" %}
<div class="post-image post-image-normal">
<a href="{{ post.url | absolute_url }}" aria-label="Thumbnail">
<img src="{{ thumbnail | absolute_url }}" alt="Post thumbnail">
</a>
</div>
{% endif %}
{% endif %}
<a href="{{ post.url | absolute_url }}">
<h2 class="post-title">{{ post.title }}</h2>
@ -24,47 +49,39 @@ layout: page
Posted on {{ post.date | date: date_format }}
</p>
<div class="post-entry-container">
{%- capture thumbnail -%}
{% if post.thumbnail-img %}
{{ post.thumbnail-img }}
{% elsif post.cover-img %}
{% if post.cover-img.first %}
{{ post.cover-img[0].first.first }}
{% else %}
{{ post.cover-img }}
{% endif %}
{% else %}
{% endif %}
{% endcapture %}
{% assign thumbnail=thumbnail | strip %}
{% if thumbnail != "" %}
<div class="post-image">
<a href="{{ post.url | absolute_url }}">
<img src="{{ thumbnail | absolute_url }}">
</a>
</div>
{% endif %}
<div class="post-entry">
{% assign excerpt_length = site.excerpt_length | default: 50 %}
{{ post.excerpt | strip_html | xml_escape | truncatewords: excerpt_length }}
{% assign excerpt_word_count = post.excerpt | number_of_words %}
{% if post.content != post.excerpt or excerpt_word_count > excerpt_length %}
<a href="{{ post.url | absolute_url }}" class="post-read-more">[Read&nbsp;More]</a>
{% endif %}
</div>
{% if thumbnail != "" %}
<div class="post-image post-image-small">
<a href="{{ post.url | absolute_url }}" aria-label="Thumbnail">
<img src="{{ thumbnail | absolute_url }}" alt="Post thumbnail">
</a>
</div>
{% endif %}
{% if post.tags.size > 0 %}
{% unless site.feed_show_excerpt == false %}
{% if thumbnail != "" %}
<div class="post-image post-image-short">
<a href="{{ post.url | absolute_url }}" aria-label="Thumbnail">
<img src="{{ thumbnail | absolute_url }}" alt="Post thumbnail">
</a>
</div>
{% endif %}
<div class="post-entry">
{% assign excerpt_length = site.excerpt_length | default: 50 %}
{{ post.excerpt | strip_html | xml_escape | truncatewords: excerpt_length }}
{% assign excerpt_word_count = post.excerpt | number_of_words %}
{% if post.content != post.excerpt or excerpt_word_count > excerpt_length %}
<a href="{{ post.url | absolute_url }}" class="post-read-more">[Read&nbsp;More]</a>
{% endif %}
</div>
{% endunless %}
{% if site.feed_show_tags != false and post.tags.size > 0 %}
<div class="blog-tags">
Tags:
{% if site.link-tags %}
<span>Tags:</span>
{% for tag in post.tags %}
<a href="{{ '/tags' | absolute_url }}#{{- tag -}}">{{- tag -}}</a>
{% endfor %}
{% else %}
{{ post.tags | join: ", " }}
{% endif %}
</div>
{% endif %}

View File

@ -1,12 +1,12 @@
---
common-css:
- "/assets/css/main-minimal.css"
- "/assets/css/beautifuljekyll-minimal.css"
common-ext-css:
- href: "https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css"
sri: "sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh"
common-ext-js:
- href: "https://code.jquery.com/jquery-3.4.1.min.js"
sri: "sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo="
- href: "https://code.jquery.com/jquery-3.5.1.slim.min.js"
sri: "sha256-4+XzXVhsDmqanXGHaHvgh1gMQKX40OUvDEBTu8JcmNs="
- href: "https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js"
sri: "sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo"
- href: "https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/js/bootstrap.min.js"
@ -20,8 +20,24 @@ common-ext-js:
<body>
<div role="main" class="container-md main-content">
<div role="main" class="{% if page.full-width %} container-fluid {% else %} container-md {% endif %} main-content">
{% if page.before-content %}
<div class="before-content">
{% for file in page.before-content %}
{% include {{ file }} %}
{% endfor %}
</div>
{% endif %}
{{ content }}
{% if page.after-content %}
<div class="after-content">
{% for file in page.after-content %}
{% include {{ file }} %}
{% endfor %}
</div>
{% endif %}
</div>
{% include footer-minimal.html %}

View File

@ -4,10 +4,27 @@ layout: base
{% include header.html type="page" %}
<div class="container-md" role="main">
<div class="{% if page.full-width %} container-fluid {% else %} container-md {% endif %}" role="main">
<div class="row">
<div class="col-xl-8 offset-xl-2 col-lg-10 offset-lg-1">
<div class="{% if page.full-width %} col {% else %} col-xl-8 offset-xl-2 col-lg-10 offset-lg-1 {% endif %}">
{% if page.before-content %}
<div class="before-content">
{% for file in page.before-content %}
{% include {{ file }} %}
{% endfor %}
</div>
{% endif %}
{{ content }}
{% if page.after-content %}
<div class="after-content">
{% for file in page.after-content %}
{% include {{ file }} %}
{% endfor %}
</div>
{% endif %}
{% include comments.html %}
</div>
</div>

View File

@ -4,9 +4,9 @@ layout: base
{% include header.html type="post" %}
<div class="container-md">
<div class="{% if page.full-width %} container-fluid {% else %} container-md {% endif %}">
<div class="row">
<div class="col-xl-8 offset-xl-2 col-lg-10 offset-lg-1">
<div class="{% if page.full-width %} col {% else %} col-xl-8 offset-xl-2 col-lg-10 offset-lg-1 {% endif %}">
{% if page.gh-repo %}
{% assign gh_split = page.gh-repo | split:'/' %}
@ -31,20 +31,32 @@ layout: base
</div>
{% endif %}
{% if page.before-content %}
<div class="before-content">
{% for file in page.before-content %}
{% include {{ file }} %}
{% endfor %}
</div>
{% endif %}
<article role="main" class="blog-post">
{{ content }}
</article>
{% if page.tags.size > 0 %}
<div class="blog-tags">
Tags:
{% if site.link-tags %}
<span>Tags:</span>
{% for tag in page.tags %}
<a href="{{ '/tags' | relative_url }}#{{- tag -}}">{{- tag -}}</a>
{% endfor %}
{% else %}
{{ page.tags | join: ", " }}
{% endif %}
</div>
{% endif %}
{% if page.after-content %}
<div class="after-content">
{% for file in page.after-content %}
{% include {{ file }} %}
{% endfor %}
</div>
{% endif %}

View File

@ -11,6 +11,6 @@ My name is Inigo Montoya. I have the following qualities:
What else do you need?
### my history
### My story
To be honest, I'm having some trouble remembering right now, so why don't you just watch [my movie](https://en.wikipedia.org/wiki/The_Princess_Bride_%28film%29) and it will answer **all** your questions.

View File

@ -10,4 +10,4 @@ footer.footer-min {
background-color: #f5f5f5;
border-top: 1px solid #eeeeee;
text-align: center;
}
}

View File

@ -42,6 +42,9 @@ h3 {
h4 {
font-size: 1.125rem;
}
h1, h2, h3, h4 {
margin-top: 1.25rem;
}
a {
color: {{ site.link-col | default: "#008AFF" }};
}
@ -65,7 +68,7 @@ hr.small {
}
/* fix in-page anchors to not be behind fixed header */
:target:before {
:target:before {
content: "";
display: block;
height: 3.125rem; /* navbar height */
@ -108,6 +111,13 @@ img {
max-width: 100%;
}
.linked-section {
padding-top: 3.75rem;
margin-top: -1.5625rem;
}
/* Comments */
.disqus-comments {
margin-top: 1.875rem;
}
@ -118,16 +128,11 @@ img {
}
}
.linked-section {
padding-top: 3.75rem;
margin-top: -1.5625rem;
}
/* --- Navbar --- */
.navbar-custom {
background-color: {{ site.navbar-col | default: "#F5F5F5" }};
border-bottom: 1px solid {{ site.navbar-border-col | default: "#EAEAEA" }};
background-color: {{ site.navbar-col | default: "#EAEAEA" }};
border-bottom: 1px solid {{ site.navbar-border-col | default: "#DDDDDD" }};
font-family: 'Open Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif;
{% if site.navbar-img %}
background-image: url({{ site.navbar-img | relative_url }});
@ -188,16 +193,16 @@ img {
.navbar-custom .navbar-nav .nav-item {
text-transform: uppercase;
font-size: 0.75rem;
font-size: 0.8125rem;
letter-spacing: 0.0625rem;
}
.navbar-custom .navbar-nav .nav-link {
padding-top: 0;
padding-bottom: 0;
line-height: 1.5;
padding-top: 1rem;
padding-bottom: 1rem;
line-height: 1.25rem;
padding-top: 0.9375rem;
padding-bottom: 0.9375rem;
}
.navbar-custom .navbar-brand,
@ -270,7 +275,7 @@ img {
.navbar-custom .nav-item.dropdown .dropdown-menu .dropdown-item {
white-space: normal;
padding: 0.625rem;
background-color: {{ site.navbar-col | default: "#F5F5F5" }};
background-color: {{ site.navbar-col | default: "#EAEAEA" }};
text-decoration: none !important;
border-width: 0 1px 1px 1px;
font-weight: normal;
@ -283,14 +288,14 @@ img {
.navbar-custom .nav-item.dropdown .dropdown-menu .dropdown-item {
padding-left: 0.625rem;
border: 1px solid {{ site.navbar-border-col | default: "#EAEAEA" }};
border: 1px solid {{ site.navbar-border-col | default: "#DDDDDD" }};
border-width: 0 1px 1px;
}
}
@media (max-width: 767px) {
.navbar-custom .navbar-collapse {
border-top: 1px solid {{ site.navbar-border-col | default: "#EAEAEA" }};
border-top: 1px solid {{ site.navbar-border-col | default: "#DDDDDD" }};
margin: 0 -1rem;
}
@ -315,7 +320,7 @@ img {
position: absolute;
left: 50%;
width: 3.125rem;
margin-top: 1.75rem;
margin-top: 3.1rem;
transition: opacity 0.5s ease-in-out;
-webkit-transition: opacity 0.5s ease-in-out;
-moz-transition: opacity 0.5s ease-in-out;
@ -330,7 +335,6 @@ img {
.navbar-custom .avatar-container .avatar-img-border {
width: 100%;
display: inline-block;
margin-left: -50%;
{% unless site.round-avatar == false %}
border-radius: 50%;
@ -352,11 +356,11 @@ img {
}
@media (min-width: 768px) {
.navbar-custom .avatar-container {
.navbar-custom.top-nav-regular .avatar-container {
width: 6.25rem;
}
.navbar-custom .avatar-container .avatar-img-border {
.navbar-custom.top-nav-regular .avatar-container .avatar-img-border {
width: 100%;
{% unless site.round-avatar == false %}
box-shadow: 1px 1px 2px rgba(0, 0, 0, .8);
@ -365,7 +369,7 @@ img {
{% endunless %}
}
.navbar-custom .avatar-container .avatar-img {
.navbar-custom.top-nav-regular .avatar-container .avatar-img {
width: 100%;
}
}
@ -377,7 +381,7 @@ footer {
border-top: 1px #EAEAEA solid;
margin-top: 3.125rem;
font-size: 0.875rem;
background-color: {{ site.footer-col | default: "#F5F5F5" }};
background-color: {{ site.footer-col | default: "#EAEAEA" }};
{% if site.footer-img %}
background-image: url({{ site.footer-img | relative_url }});
background-attachment: fixed;
@ -428,11 +432,12 @@ footer .footer-custom-content {
}
}
/* --- Post preview --- */
/* --- Post preview (feed) --- */
.post-preview {
padding: 1.25rem 0;
border-bottom: 1px solid #eee;
overflow: hidden;
}
@media (min-width: 768px) {
@ -447,6 +452,7 @@ footer .footer-custom-content {
.post-preview a {
text-decoration: none;
font-family: 'Open Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif;
color: {{ site.text-col | default: "#404040" }};
}
@ -471,33 +477,70 @@ footer .footer-custom-content {
font-size: 1.125rem;
font-style: italic;
margin: 0 0 0.625rem;
font-family: 'Lora', 'Times New Roman', serif;
}
.post-heading .post-meta {
display: inline-block;
}
@media (max-width: 767px) {
.post-heading .post-meta {
display: block;
margin-bottom: 0;
}
}
.post-heading .post-meta .middot {
margin: 0 0.625rem;
}
.post-preview .post-entry {
font-family: 'Open Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif;
}
.post-entry-container {
display: inline-block;
width: 100%;
}
.post-entry {
width: 100%;
}
.post-image {
.post-preview .post-image {
float: right;
margin-left: 0.625rem;
height: 12rem;
width: 12rem;
margin-top: -2.1875rem;
}
.post-preview .post-image {
filter: grayscale(90%);
}
.post-image:hover {
.post-preview .post-image:hover {
filter: grayscale(0%);
}
.post-image img {
border-radius: 6.25rem;
height: 12rem;
width: 12rem;
.post-preview .post-image img {
height: 100%;
width: 100%;
}
.post-preview .post-image-short {
margin-top: -2.1875rem;
}
@media (max-width: 767px) {
.post-preview .post-image {
height: 9rem;
width: 9rem;
}
.post-preview .post-image-short {
margin-top: 0;
}
}
.post-preview .post-image-small {
width: 100%;
height: 100%;
text-align: center;
display: none;
}
.post-preview .post-image-small img {
width: 6.25rem;
height: 6.25rem;
}
@media (max-width: 500px) {
.post-preview .post-image {
display: none;
}
.post-preview .post-image-small {
display: block;
}
}
.post-preview .post-read-more {
font-weight: 800;
}
@ -512,21 +555,28 @@ footer .footer-custom-content {
.blog-tags {
font-family: 'Open Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif;
color: #999;
font-size: 0.9375rem;
margin-bottom: 1.875rem;
}
.blog-tags span {
color: {{ site.text-col | default: "#404040" }};
opacity: 0.8;
}
.blog-tags a {
color: {{ site.link-col | default: "#008AFF" }};
color: {{ site.text-col | default: "#404040" }};
text-decoration: none;
padding: 0 0.3125rem;
opacity: 0.8;
border: 1px solid transparent;
border-radius: 0.1875rem;
}
.blog-tags a:hover {
border-radius: 2px;
color: {{ site.hover-col | default: "#0085A1" }};
background-color: #EEE;
opacity: 1;
color: {{ site.text-col | default: "#404040" }};
border-color: {{ site.text-col | default: "#404040" }};
}
.post-preview .blog-tags {
@ -540,28 +590,30 @@ footer .footer-custom-content {
}
}
@media (max-width: 767px) {
.post-image, .post-image img {
margin-top: 0;
height: 9rem;
width: 9rem;
}
/* Tags page */
.tag-btn {
margin: 0.3125rem;
}
@media (max-width: 500px) {
.post-image, .post-image img {
height: 6.25rem;
width: 6.25rem;
}
.post-image {
width: 100%;
text-align: center;
margin-top: 0;
margin-left: 0;
float: none;
}
#full-tags-list {
font-family: 'Open Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif;
}
#full-tags-list .tag-entry {
margin: 0 0 0.9375rem 1.5625rem;
}
#full-tags-list .tag-entry a {
font-size: 1.25rem;
}
#full-tags-list .tag-entry .entry-date {
color: #808080;
font-style: italic;
font-size: 1rem;
}
/* --- Post and page headers --- */
.intro-header {
@ -577,6 +629,12 @@ footer .footer-custom-content {
margin-top: 3.1875rem; /* The small navbar is 50px tall + 1px border */
margin-bottom: 2.1875rem;
}
nav.top-nav-short-permanent ~ header > .intro-header {
margin-top: 5rem;
}
nav.top-nav-short-permanent ~ header > .intro-header.big-img {
margin-top: 3.1875rem;
}
.intro-header.big-img .big-img-transition {
position: absolute;
width: 100%;
@ -698,17 +756,6 @@ footer .footer-custom-content {
}
}
.caption {
text-align: center;
font-size: 0.875rem;
padding: 0.625rem;
font-style: italic;
margin: 0;
display: block;
border-bottom-right-radius: 0.3125rem;
border-bottom-left-radius: 0.3125rem;
}
#header-gh-btns {
margin-bottom: 0.9375rem;
}
@ -719,18 +766,6 @@ footer .footer-custom-content {
}
}
.reader-time {
display: inline-block;
}
@media (max-width: 767px) {
.reader-time {
display: block;
}
}
.reader-time .middot {
margin: 0 0.625rem;
}
/* --- Pagination --- */
.pagination {
@ -813,9 +848,22 @@ table tr td :last-child {
/* --- Code blocks --- */
code {
padding: 0.125rem 0.25rem;
color: #c7254e;
background-color: #f9f2f4;
border-radius: 0.25rem;
}
pre code {
padding: 0;
background-color: transparent;
border-radius: 0;
}
pre {
font-size: 1rem;
line-height: 1.5;
font-size: 0.875rem;
line-height: 1.5em;
border-radius: 0.25rem;
padding: 0.59375rem;
}
@ -826,7 +874,7 @@ pre {
}
.highlight > pre {
background-image: linear-gradient(
rgba(0,0,0,0.06), rgba(0,0,0,0.06) 1.5em, rgba(0,0,0,0.03) 1.5em, rgba(0,0,0,0.03) 3em);
rgba(0,0,0,0.03), rgba(0,0,0,0.03) 1.5em, rgba(0,0,0,0.02) 1.5em, rgba(0,0,0,0.02) 3em);
background-size: auto 3em;
background-position-y: 0.625rem;
border: 1px solid rgba(0,0,0,0.1);
@ -858,10 +906,21 @@ pre {
background: none;
}
/* Fix table border github gist snippets */
.gist, .gist-file table tr {
border: unset;
}
.gist, .gist-file table tr td {
border: unset;
}
/* --- Social media sharing section --- */
#social-share-section {
margin-bottom: 1.875rem;
margin-top: 1.875rem;
}
/* --- Notification boxes --- */
@ -893,36 +952,47 @@ pre {
border-left-color: #3CB371;
}
/* Fix table border github gist snippets */
/* --- Misc blog post styles --- */
.gist, .gist-file table tr {
border: unset;
.blog-post :first-child {
margin-top: 0;
}
.gist, .gist-file table tr td {
border: unset;
.blog-post img {
max-width: 100%;
}
/* Tags page */
.tag-btn {
margin: 0.3125rem;
}
#full-tags-list {
font-family: 'Open Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif;
}
#full-tags-list .tag-entry {
margin: 0 0 0.9375rem 1.5625rem;
}
#full-tags-list .tag-entry a {
font-size: 1.25rem;
}
#full-tags-list .tag-entry .entry-date {
color: #808080;
.blog-post .caption {
text-align: center;
font-size: 0.875rem;
padding: 0.625rem;
font-style: italic;
font-size: 1rem;
color: #777;
margin: 0;
display: block;
border-bottom-right-radius: 0.3125rem;
border-bottom-left-radius: 0.3125rem;
}
.blog-post hr {
max-width: 25%;
border-width: 0.25rem;
border-radius: 0.1875rem;
border-color: #808080;
}
.blog-post blockquote {
padding: 0.625rem 1.25rem;
margin: 0 0 1.25rem;
font-size: 1.1rem;
border-left: 0.3125rem solid #eee;
}
.blog-post blockquote p:last-child {
margin-bottom: 0;
}
.center {
display: block;
margin: 0 auto;
}

View File

@ -6,6 +6,8 @@ var BeautifulJekyllJS = {
numImgs : null,
init : function() {
setTimeout(BeautifulJekyllJS.initNavbar, 10);
// Shorten the navbar after scrolling a little bit down
$(window).scroll(function() {
if ($(".navbar").offset().top > 50) {
@ -27,6 +29,19 @@ var BeautifulJekyllJS = {
BeautifulJekyllJS.initImgs();
},
initNavbar : function() {
// Set the navbar-dark/light class based on its background color
const rgb = $('.navbar').css("background-color").replace(/[^\d,]/g,'').split(",");
const brightness = Math.round(( // http://www.w3.org/TR/AERT#color-contrast
parseInt(rgb[0]) * 299 +
parseInt(rgb[1]) * 587 +
parseInt(rgb[2]) * 114
) / 1000);
if (brightness <= 125) {
$(".navbar").removeClass("navbar-light").addClass("navbar-dark");
}
},
initImgs : function() {
// If the page was large images to randomly select from, choose an image
if ($("#header-big-imgs").length > 0) {

File diff suppressed because one or more lines are too long

View File

@ -2,7 +2,7 @@
Gem::Specification.new do |spec|
spec.name = "beautiful-jekyll-theme"
spec.version = "4.1.0"
spec.version = "5.0.0"
spec.authors = ["Dean Attali"]
spec.email = ["daattali@gmail.com"]
@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(assets|_layouts|_includes|LICENSE|README|feed|404|_data|tags|staticman)}i) }
spec.metadata = {
"changelog_uri" => "https://github.com/daattali/beautiful-jekyll/blob/master/CHANGELOG.md",
"changelog_uri" => "https://beautifuljekyll.com/updates/",
"documentation_uri" => "https://github.com/daattali/beautiful-jekyll#readme"
}
@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
spec.add_runtime_dependency "jekyll-paginate", "~> 1.1"
spec.add_runtime_dependency "jekyll-sitemap", "~> 1.4"
spec.add_runtime_dependency "kramdown-parser-gfm", "~> 1.1"
spec.add_runtime_dependency "kramdown", "~> 2.3.0"
spec.add_development_dependency "bundler", ">= 1.16"
spec.add_development_dependency "rake", "~> 12.0"

View File

@ -7,17 +7,18 @@ layout: null
{% if site.title %}
<title>{{ site.title | xml_escape }}</title>
{% endif %}
{% if site.description %}
<description>{{ site.description | xml_escape }}</description>
{% if site.rss-description %}
<description>{{ site.rss-description | xml_escape }}</description>
{% endif %}
<link>{{ '' | absolute_url }}</link>
<atom:link href="{{ 'feed.xml' | absolute_url }}" rel="self" type="application/rss+xml" />
{% assign excerpt_length = site.excerpt_length | default: 50 %}
{% for post in site.posts limit:20 %}
<item>
<title>{{ post.title | xml_escape }}</title>
<description>
{% if post.subtitle %}{{ post.subtitle | xml_escape }} - {% endif %}
{{ post.content | strip_html | xml_escape | truncatewords: 50 }}
{{ post.content | strip_html | xml_escape | truncatewords: excerpt_length }}
</description>
<pubDate>{{ post.date | date: "%a, %d %b %Y %H:%M:%S %z" }}</pubDate>
<link>{{ post.url | absolute_url }}</link>

View File

@ -3,4 +3,3 @@ layout: home
title: My website
subtitle: This is where I will tell my friends way too much about me
---