diff --git a/.github/issue_template.md b/.github/issue_template.md index bbe50146cf2f..2e25e5c9e57e 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -1,3 +1,3 @@ Please only submit feature suggestions or bug reports if you believe something is broken. -If you need help, or if you enjoy Beautiful Jekyll and want to support it, please upgrade to one of our plans: https://beautifuljekyll.com/plans/ +If you need help, you can attend the [Office Hours](https://beautifuljekyll.com/officehours) (only available for [sponsors](https://beautifuljekyll.com/plans/)). diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dcb9d5a3b73a..511db2886e4a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,7 +5,7 @@ jobs: name: Build Jekyll runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Build the site in the jekyll/builder container run: | export JEKYLL_VERSION=3.8 diff --git a/CHANGELOG.md b/CHANGELOG.md index 61436a3deb5f..e9ee8b837160 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,27 +1,54 @@ ## Unreleased version +- BREAKING CHANGE: Allow changing the order of the social network links that appear in the footer (#1152) +- BREAKING CHANGE: `google-scholar` social network link no longer requires the prefix `citations?user=`; if you previously set this parameter, it needs to be updated (#1189) +- The footer of a page always sticks to the bottom, even on short pages (#576) +- Added `author` YAML parameter to allow specifying the author(s) of a post (#1220) +- Fixed bug where hovering over search results showed the text "{desc}" (#1156) +- Added social network links for GitLab, Bluesky (#1168, #1218) +- Added instructions and example on how to fix image links in project sites (#1171) +- Pagination buttons: use nicer arrows, and don't show text on small screens (#1221) + +## v6.0.1 (2023-06-08) + +This version has been in the works for a few years. It includes several new features that were highly requested, numerous bug fixes, new documentation, and aggresively encourages migrating from the old Google Universal Analytics to the new Analytics 4. + +#### Breaking changes + +- As of July 2023, Google Universal Analytics is going away and being replaced by Google Analytics 4. Beautiful Jekyll sites that still use the old analytics tag will show a warning to encourage them to move to Analytics 4 (#1096). +- More control over RSS feed sharing: previously, an RSS feed was *always* generated, and if the config setting `rss-description` was set then there was an RSS icon in the footer. Now, an RSS feed is only generated when the config setting `rss-description` exists, and an RSS footer icon is only shown if `rss: true` is set in the `social-network-links` config settings. + +#### New parameters and settings - Added `navbar-var-length` config setting that allows the navigation menu to be the same length as the longest sub-menu, so that long words in the submenu are not cut off (#765) -- Added `post_search` config setting that creates a Search button in the navbar (older websites need to set `post_search: true` to enable this feature) (#770) +- Added `post_search` config setting that creates a Search button in the navbar (#770) - Added `edit_page_button` config setting that adds a "Edit page" button to the footer (to edit the current page on GitHub) (#1004) -- BREAKING CHANGE: More control over RSS feed sharing: previously, an RSS feed was *always* generated, and if the config setting `rss-description` was set then there was an RSS icon in the footer. Now, an RSS feed is only generated when the config setting `rss-description` exists, and an RSS footer icon is only shown if `rss: true` is set in the `social-network-links` config settings +- Added `footer-hover-col` config setting to customize the hover colour of links in the footer (#848) + +#### New features and improvements + +- Made the home page feed more accessible for screen readers (#950) +- Added support for giscus comments (#886) and CommentBox (#960) +- Added support for Cloudflare Analytics (#797) +- Added Reddit in share options of posts (#815) + +#### Bug fixes + - Fixed page titles, subtitles, and excerpts rendering correctly when there are special characeters in them (#856) -- Slightly reworked margins and position for avatar image to resolve an alignment issue on Safari. -- Changed the width at which the navbar collapses to a higher threshold because most modern non-mobile browsers are >1000px - Fixed bug where navbar secondary level dropdown items didn't inherit the same colour as the primary navbar links - Fixed bug where the navbar "burger" collapsed button didn't always revert back to a light colour - Fixed bug where using an image as a navbar title did not render in GitHub Project pages that did not have a custom domain -- Fixed issue where image thumbnails on the feed page were always forced into a square rather than maintaining a proper image aspect ratio -- Added support for Patreon, Medium, and Itch.io in the social network links in the footer (#783, #788) +- Fixed bug where image thumbnails on the feed page were always forced into a square rather than maintaining a proper image aspect ratio - Fixed bug where special characters in the title led to broken share tags (#744) -- Updated staticman from using v2 (public servers) to v3 (private servers) due to the public servers becoming obsolete (#775) -- Added support for Cloudflare Analytics (#797) -- Added Reddit in share options of posts (#815) -- Added support for giscus comments (#886) and CommentBox (#960) - Fixed bug where staticman didn't work jQuery slim version is used (#766) - Fixed very long strings to wrap around the next line rather than go off-screen (#787) -- Added `footer-hover-col` config setting to customize the hover colour of links in the footer (#848) -- Added social network links for Discord (#907), Kaggle (#961), and Hackerrank (#978) -- Made the home page feed more accessible for screen readers (#950) + +#### Small changes + +- Updated staticman from using v2 (public servers) to v3 (private servers) due to the public servers becoming obsolete (#775) +- Added social network links for Patreon, Medium, Itch.io, Discord, Kaggle, Hackerrank (#783, #788, #907, #961, #978) +- Slightly reworked margins and position for avatar image to resolve an alignment issue on Safari +- Changed the width at which the navbar collapses to a higher threshold because most modern non-mobile browsers are >1000px + ## v5.0.0 (2020-09-15) @@ -68,7 +95,6 @@ One of the major changes in this version is that a lot of time was spent on reth - 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 diff --git a/LICENSE b/LICENSE index 27e2cdf65595..0b6ae57226ca 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2020 Dean Attali +Copyright (c) 2023 Dean Attali Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 25f0df69ec7d..7f96ae38ba51 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -[![](https://i.imgur.com/zNBkzj1.png)](https://beautifuljekyll.com/plans/) - # Beautiful Jekyll [![Gem Version](https://badge.fury.io/rb/beautiful-jekyll-theme.svg)](https://badge.fury.io/rb/beautiful-jekyll-theme) @@ -8,7 +6,7 @@ **Beautiful Jekyll** is a ready-to-use template to help you create a beautiful website quickly. Perfect for personal sites, blogs, or simple project websites. [Check out a demo](https://beautifuljekyll.com) of what you'll get after just two minutes. You can also look at [my personal website](https://deanattali.com) or [my consulting website](https://attalitech.com) to see it in use, or see [examples of websites](http://beautifuljekyll.com/examples) other people created using this theme. -**If you enjoy Beautiful Jekyll, please consider [supporting me](https://github.com/sponsors/daattali) for over 5 years of development (and to unlock rewards!) ❤** +**If you enjoy Beautiful Jekyll, please consider [supporting me](https://github.com/sponsors/daattali). You'll also gain access to office hours and more features! ❤** ## Table of contents @@ -20,8 +18,9 @@ - [Customizing parameters for each page](#customizing-parameters-for-each-page) - [Supported parameters](#supported-parameters) - [Featured users (success stories!)](#featured-users-success-stories) -- [FAQ and support](#faq-and-support) -- [Credits and contributions](#credits) +- [Next steps](#next-steps) +- [Getting help](#getting-help) +- [Credits and contributions](#contributions) # Features @@ -45,61 +44,61 @@ __Check out [*What's New?*](https://beautifuljekyll.com/updates/) to see the lat Developing and maintaining Beautiful Jekyll takes a lot of time and effort - thank you to anyone who helps fund this effort! -- [LoadView-Testing](https://www.loadview-testing.com/products/jmeter-load-testing/) - [DoFollow](https://dofollow.co.uk/) - [\_hyp3ri0n](https://hyperiongray.com) +- [Varna Sri Raman](https://about.me/varna) -**[Become a sponsor for Beautiful Jekyll and unlock special rewards\!](https://github.com/sponsors/daattali/sponsorships?tier_id=39856)** +**[Become a sponsor for Beautiful Jekyll and unlock new features\!](https://github.com/sponsors/daattali/sponsorships?tier_id=39856)** # Build your website in 3 steps -There's a very easy way to use this theme, and there's a hard way. For most people (including myself!), the easy route is recommended. 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. +There are a few different ways to build a website using Beautiful Jekyll, and this document will go through the simplest one: using a fork on GitHub. For most people (including myself!), this easy method is the recommended one. + +Even if you choose to use one of the [advanced installation methods](https://beautifuljekyll.com/getstarted/#install-steps-hard), I still suggest you read through the easy method first. ## The easy way (recommended!) Getting started is *literally* as easy as 1-2-3 :smile: -> A reminder for *advanced users only*: you can follow the instructions for [building locally](https://beautifuljekyll.com/getstarted/#install-steps-hard) if you want more control but higher difficulty - -Scroll down to see the steps involved, but here is a 40-second video just as a reference as you work through the steps. If you don't already have a [GitHub account](https://github.com/join), you'll need to sign up. +Scroll down to see the steps involved, but here is a 30-second video just as a reference as you work through the steps. If you don't already have a [GitHub account](https://github.com), you'll need to sign up. -![Installation steps](assets/img/install-steps.gif) +![Installation steps](https://beautifuljekyll.com/assets/img/install-steps.gif) ### 1. Fork this project -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. +Click on the __*Fork*__ button at the top right corner of this page. Forking means that you're copying this entire project and all its files into your account. Do not click on the __*Create fork*__ button on the next page yet. -### 2. Rename the project to `.github.io` +### 2. Rename the repository 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://.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. +You'll see the word "repository" used a lot in GitHub - it simply means "project". Under __*Repository name*__ you should see the name `beautiful-jekyll`, this is where you need to rename your project to `YOURUSERNAME.github.io` (replace `YOURUSERNAME` with your GitHub user name). It's important to use this exact name so that GitHub will recognize it and automatically create a website for this project. +> Tip: If you want to use a different URL for your website, check out the [FAQ](https://beautifuljekyll.com/faq/#custom-domain) + ### 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 there are comments inside the file to help you understand what each setting does. Any line that begins with a hashtag (`#`) is a comment, and the other lines are actual settings. +Edit the `_config.yml` file to change any settings you want. To edit the file, first click on it to view the file, and on the next page click on the pencil icon to edit it (watch the video tutorial above if you're confused). The settings in the file are self-explanatory and there are comments inside the file to help you understand what each setting does. Any line that begins with a hashtag (`#`) is a comment, and the other lines are actual settings. After changing the settings, click the green __*Commit changes*__ button to save these edits. -Note that in the video above only one setting in the `_config.yml` file is edited. **You should actually go through the rest of the settings as well. Don't be lazy, go through all the settings!** +> Note: In the video above, only one setting in the `_config.yml` file is edited, but you should go through the rest of the settings as well. ### 4. Congratulations! You have a website! -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://.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. +If you named your project correctly and made an edit to the config file, your website should be ready in a minute or two at `https://YOURUSERNAME.github.io`. Every time you make a change to any file, your website will get rebuilt and should be updated in about a minute or so. Your website will be initialized with several sample blog posts and a couple other pages. -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 harder way (for advanced users) -## The hard way (using ruby gems) +The instructions above explain how to use Beautiful Jekyll in the easiest way: by forking on GitHub. There are more [advanced installation methods](https://beautifuljekyll.com/getstarted/#install-steps-hard) that include either using GitHub Pages with remote themes, or using Ruby gems. They provide you with more control, but are only intended for advanced users. -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. +> Note: Beautiful Jekyll was primarily designed to be used as a GitHub theme, so you will not get any support if you use this theme via Ruby gems. # 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 the development efforts, [check out the different plans](https://beautifuljekyll.com/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, access office hours, or simply support the 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 that's the recommended approach ([here's a great tutorial](https://markdowntutorial.com/) if you need to learn markdown in 5 minutes). -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! +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. @@ -165,6 +164,7 @@ These are parameters that you may not use often, but can come in handy sometimes Parameter | Description ----------- | ----------- +author | Specify the author of a blog post (useful if a website has multiple authors). 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`. 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`. @@ -205,22 +205,33 @@ Visit the [Official website](http://beautifuljekyll.com/examples) to see sample 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 +# Next steps -Visit the [official FAQ page](https://beautifuljekyll.com/faq) for answers to commonly asked questions. +Congratulations on making it this far! You now have all the tools to easily build a beautiful website for free. -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/). +- After you get comfortable with the basics of writing in markdown, I suggest taking a look at this [sample post](https://beautifuljekyll.com/2020-02-28-sample-markdown/) and [the code that created it](https://raw.githubusercontent.com/daattali/beautiful-jekyll/master/_posts/2020-02-28-sample-markdown.md) to learn some more advanced tips about markdown. + +- I highly recommend going over the [*Frequently Asked Questions*](https://beautifuljekyll.com/faq/) to find out answers to questions you may not even know you have. Every few months I suggest checking the [*What's New?*](https://beautifuljekyll.com/updates/) page to see if there are new features, and learn [how to update your site to the newest version](https://beautifuljekyll.com/faq/#updating) when it's time. -To receive support, select one of the [different plans](https://beautifuljekyll.com/plans) Beautiful Jekyll offers. You can also use the [Discussions](https://github.com/daattali/beautiful-jekyll/discussions) area to try to get help from the community. +- You can also check out the [advanced installation methods](https://beautifuljekyll.com/getstarted/#install-steps-hard) that give you a little more control but are harder to use. Keep in mind that Beautiful Jekyll was primarily designed to be used as a GitHub theme, so you will not get any support if you choose one of the Ruby installation methods. + +# Getting help + +Visit the [FAQ page](https://beautifuljekyll.com/faq) for answers to commonly asked questions. + +**If you choose to [become a sponsor](https://beautifuljekyll.com/plans/), you'll have access to my [office hours](https://beautifuljekyll.com/officehours/) where you can ask for help.** You can also use the [Discussions](https://github.com/daattali/beautiful-jekyll/discussions) area to try and get help from the community. + +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/). # 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. -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. +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. + diff --git a/_config.yml b/_config.yml index 6d4c337e1a63..3a20d673ca06 100644 --- a/_config.yml +++ b/_config.yml @@ -50,6 +50,7 @@ round-avatar: true ##################################### # Select the social network links that you want to show in the footer. +# You can change the order that they show up on the page by changing the order here. # Uncomment the links you want to show and add your information to each one. social-network-links: email: "nicolas.elie@cnrs.fr" @@ -74,11 +75,13 @@ social-network-links: # telegram: yourname # calendly: yourname # mastodon: instance.url/@username +# bluesky: yourname # ORCID: your ORCID ID # google-scholar: your google scholar -# discord: invite/invite_code or users/userid +# discord: "invite_code" or "users/userid" or "invite/invite_code" # kaggle: yourname # hackerrank: yourname +# gitlab: yourname # If you want your website to generate an RSS feed, provide a description # The URL for the feed will be https:///feed.xml @@ -162,11 +165,8 @@ footer-hover-col: "#0085A1" # --- 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 Google Analytics -#google_analytics: "" +# Fill in your Google Analytics tag ID (or "Measurement ID") to track your website usage +#gtag: "G-XXXXXXXXXX" # Fill in your Cloudflare Analytics beacon token to track your website using Cloudflare Analytics #cloudflare_analytics: "" @@ -182,6 +182,11 @@ footer-hover-col: "#0085A1" # uri: "demo.wiki.pro" # opt-out: true +# Google Universal Analytics ID -- deprecated +# As of July 2023 this is no longer supported by Google! If you are still using `google_analytics`, +# you should switch to using the `gtag` field above instead. +#google_analytics: "UA-XXXXXXXX-X" + #################### # --- Comments --- # #################### diff --git a/_includes/footer-minimal.html b/_includes/footer-minimal.html index c6a5af5533aa..66b295a71db4 100644 --- a/_includes/footer-minimal.html +++ b/_includes/footer-minimal.html @@ -12,7 +12,7 @@ {% if site.url-pretty %}   •   - {{ site.url-pretty }} + {{ site.url-pretty }} {% endif %} diff --git a/_includes/footer.html b/_includes/footer.html index 66d85559a86c..9bfaf547a326 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -20,7 +20,7 @@ {% if site.url-pretty %}  •  - {{ site.url-pretty }} + {{ site.url-pretty }} {% endif %} diff --git a/_includes/google_analytics.html b/_includes/google_analytics.html index 01f74066310d..6fb0698c93b4 100644 --- a/_includes/google_analytics.html +++ b/_includes/google_analytics.html @@ -1,5 +1,17 @@ {% if site.google_analytics %} +{% unless site.gtag %} +
+
×
+
+ This website is using outdated Google Analytics +
+ More info + As of July 2023, Google's Universal Analytics is going away and being replaced by Google Analytics 4. This website is still using the old Universal Analytics. In order to remove this message, the website owner must remove the google_analytics property in the website's config file, and optionally replace it with the new gtag property. +
+
+
+{% endunless %} - - - - - - diff --git a/feed.xml b/feed.xml index 6148cf15f5d6..527816ea75fc 100644 --- a/feed.xml +++ b/feed.xml @@ -10,7 +10,7 @@ layout: null {% if site.rss-description %} {{ site.rss-description | xml_escape }} {% endif %} - {{ '' | absolute_url }} + {{ '/' | absolute_url }} {% assign excerpt_length = site.excerpt_length | default: 50 %} {% for post in site.posts limit:20 %}