Skip to content

Commit

Permalink
breaking change: rss feed only generated if rss-description config ex…
Browse files Browse the repository at this point in the history
…ists; rss icon only shows if social-network-links.rss is true; closes daattali#814
  • Loading branch information
daattali committed Oct 10, 2021
1 parent ffb2751 commit d0928cb
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 3 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## Unreleased version

- 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)
- 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
- 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
Expand Down
5 changes: 3 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ round-avatar: true
# Uncomment the links you want to show and add your information to each one.
social-network-links:
email: "someone@example.com"
rss: true # remove this line if you don't want to show an RSS link at the bottom
facebook: deanattali
github: daattali
twitter: daattali
Expand All @@ -63,8 +64,8 @@ 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.
# If you want your website to generate an RSS feed, provide a description
# The URL for the feed will be https://<your_website>/feed.xml
rss-description: This website is a virtual proof that I'm awesome

# --- General options --- #
Expand Down
2 changes: 2 additions & 0 deletions _includes/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@
<meta name="keywords" content="{{ site.keywords }}">
{% endif %}

{% if site.rss-description %}
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ '/feed.xml' | absolute_url }}">
{% endif %}

{% include gtag.html %}
{% include gtm_head.html %}
Expand Down
2 changes: 1 addition & 1 deletion _includes/social-networks-links.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<ul class="list-inline text-center footer-links">

{%- if site.rss-description -%}
{%- if site.social-network-links.rss and 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">
Expand Down

0 comments on commit d0928cb

Please sign in to comment.