Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add toggle option for RSS feed visibility #2787

Merged
merged 8 commits into from
Feb 6, 2021
Merged

Add toggle option for RSS feed visibility #2787

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
876eab7
add a "hide" value in config for atom
SeanKilleen Jan 16, 2021
caba6f3
Update footer to use param
SeanKilleen Jan 16, 2021
ceac3fa
update header to use param
SeanKilleen Jan 16, 2021
6b99978
Update docs to note configuration
SeanKilleen Jan 16, 2021
ab16dfa
undo formatting
SeanKilleen Jan 16, 2021
cf594d9
use unless syntax
SeanKilleen Jan 16, 2021
78d2b78
unless syntax and indentation
SeanKilleen Jan 16, 2021
fe77361
indentation
SeanKilleen Jan 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ reCaptcha:
secret :
atom_feed:
path : # blank (default) uses feed.xml
hide : # true, false (default)
search : # true, false (default)
search_full_content : # true, false (default)
search_provider : # lunr (default), algolia, google
Expand Down
2 changes: 2 additions & 0 deletions _includes/footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
{% endfor %}
{% endif %}

{% if !site.atom_feed.hide %}
<li><a href="{% if site.atom_feed.path %}{{ site.atom_feed.path }}{% else %}{{ '/feed.xml' | relative_url }}{% endif %}"><i class="fas fa-fw fa-rss-square" aria-hidden="true"></i> {{ site.data.ui-text[site.locale].feed_label | default: "Feed" }}</a></li>
SeanKilleen marked this conversation as resolved.
Show resolved Hide resolved
{% endif %}
</ul>
</div>

Expand Down
13 changes: 8 additions & 5 deletions _includes/head.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

{% include seo.html %}

<link href="{% if site.atom_feed.path %}{{ site.atom_feed.path }}{% else %}{{ '/feed.xml' | relative_url }}{% endif %}" type="application/atom+xml" rel="alternate" title="{{ site.title }} Feed">
{% if !site.atom_feed.hide %}
SeanKilleen marked this conversation as resolved.
Show resolved Hide resolved
<link href="{% if site.atom_feed.path %}{{ site.atom_feed.path }}{% else %}{{ '/feed.xml' | relative_url }}{% endif %}"
SeanKilleen marked this conversation as resolved.
Show resolved Hide resolved
type="application/atom+xml" rel="alternate" title="{{ site.title }} Feed">
{% endif %}

<!-- https://t.co/dKP3o1e -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Expand Down Expand Up @@ -31,7 +34,7 @@
<![endif]-->

{% if site.head_scripts %}
{% for script in site.head_scripts %}
<script src="{{ script | relative_url }}"></script>
{% endfor %}
{% endif %}
{% for script in site.head_scripts %}
SeanKilleen marked this conversation as resolved.
Show resolved Hide resolved
<script src="{{ script | relative_url }}"></script>
{% endfor %}
{% endif %}
9 changes: 9 additions & 0 deletions docs/_docs/05-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,6 +559,15 @@ atom_feed:
**Note:** By default the site feed is linked in two locations: inside the [`<head>` element](https://github.com/mmistakes/minimal-mistakes/blob/master/_includes/head.html) and at the bottom of every page in the [site footer](https://github.com/mmistakes/minimal-mistakes/blob/master/_includes/footer.html).
{: .notice--info}

### Disable Feed Icons

By default the theme links to `feed.xml` generated in the root of your site by the **jekyll-feed** plugin. To remove the RSS icon in the header and footer, update `atom_feed` in `_config.yml` like so:

```yaml
atom_feed:
hide: true
```

### Site search

To enable site-wide search add `search: true` to your `_config.yml`.
Expand Down