N-archive/hacks-guide-minimal-mistakes-theme
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add toggle option for RSS feed visibility (#2787)

Browse source 
* add a "hide" value in config for atom

* Update footer to use param

* update header to use param

* Update docs to note configuration

* undo formatting

* use unless syntax

* unless syntax and indentation

* indentation
This commit is contained in:
Sean Killeen 2021-02-05 20:26:16 -05:00 committed by GitHub
parent 5fe4c4810d
commit 7bb68edf03
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 17 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
_config.yml
View file

@ -51,6 +51,7 @@ reCaptcha:
secret : secret :
atom_feed: atom_feed:
path : # blank (default) uses feed.xml path : # blank (default) uses feed.xml
hide : # true, false (default)
search : # true, false (default) search : # true, false (default)
search_full_content : # true, false (default) search_full_content : # true, false (default)
search_provider : # lunr (default), algolia, google search_provider : # lunr (default), algolia, google

4
_includes/footer.html
View file

@ -12,7 +12,9 @@
{% endfor %} {% endfor %}
{% endif %} {% endif %}
<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> {% unless 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>
{% endunless %}
</ul> </ul>
</div> </div>

6
_includes/head.html
View file

@ -2,7 +2,9 @@
{% include seo.html %} {% 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"> {% unless site.atom_feed.hide %}
<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">
{% endunless %}
<!-- https://t.co/dKP3o1e --> <!-- https://t.co/dKP3o1e -->
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
@ -34,4 +36,4 @@
{% for script in site.head_scripts %} {% for script in site.head_scripts %}
<script src="{{ script | relative_url }}"></script> <script src="{{ script | relative_url }}"></script>
{% endfor %} {% endfor %}
{% endif %} {% endif %}

9
docs/_docs/05-configuration.md
View file

@ -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). **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} {: .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 ### Site search
To enable site-wide search add `search: true` to your `_config.yml`. To enable site-wide search add `search: true` to your `_config.yml`.