Merge 8fc4001c4f into 7f630a4e31

LICENSE-Feather.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2023 Cole Bemis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -348,6 +348,41 @@ page_titles = "combined"
 All the configuration options are also described in
 [`config.toml`](../master/config.toml).
 
+
+### RSS
+
+This theme supports RSS feeds.
+To enable RSS you need to set those 3 configuration settings to valid values: 
+
+```toml
+generate_feeds = true
+author = "yourself@email.com"
+
+# Use `rss.xml` for RSS feeds and `atom.xml` for ATOM.
+feed_filenames = ["rss.xml", "atom.xml"]
+```
+
+Note that `author` is also required as part of the RSS spec.
+You can read more on https://www.getzola.org/documentation/templates/feeds/ about the potential values, since RFC 4287 requires author to be a name and not an email.
+
+To add an RSS icon to the main menu, you can add this entry to the `menu_items` :
+
+```toml
+menu_items = [
+    # RSS
+    {name = "", url = "$BASE_URL/$FEED_FILENAME"}
+]
+```
+
+You can also customize the color of the RSS icon by changing the `rss_icon_color`:
+
+```toml
+[extra]
+
+# ...
+rss_icon_color = "#ee802f"
+```
+
 ## Extending
 
 Each of the templates defines named blocks, so

config.toml

@@ -34,6 +34,9 @@ accent_color = "blue"
 # Defaults to accent color (or, if not accent color specified, to blue).
 background_color = "blue"
 
+# You can set this to any rgb hex value.
+rss_icon_color = "#ee802f"
+
 # The logo text - defaults to "Terminimal theme"
 logo_text = "Terminimal theme"
 

templates/macros/menu.html

@@ -38,11 +38,45 @@
             <ul class="menu__inner">
             {%- for item in menu_items %}
                 <li {%- if current_item and current_item == item %} class="active" {%- endif %}>
-                    {%- if item.newtab -%}
-                        <a href="{{ item.url | replace(from="$BASE_URL", to=config.base_url) | safe }}" target="_blank" rel="noopener noreferrer">{{ item.name | safe }}</a>
+
+                    <!-- RSS -->
+                    {%- set is_rss = item.url == "$BASE_URL/$FEED_FILENAME" -%}
+
+                    {%- if config.extra.rss_icon_color %}
+                        {%- set rss_icon_color = config.extra.rss_icon_color %}
+                    {%- else %}
+                        {%- set rss_icon_color = "#ee802f" %}
+                    {%- endif %}
+
+                    {%- if is_rss -%}
+                        {%- if config.generate_feeds %}
+                            {%- for feed in config.feed_filenames %}
+                                {%- if feed is containing('rss') %}
+                                    <a rel="alternate" type="application/rss+xml" title="RSS Feed" href="{{ get_url(path=feed, trailing_slash=false, lang=lang) | safe }}" />
+                                {% endif -%}
+                                {%- if feed is containing('atom') %}
+                                    <a rel="alternate" type="application/atom+xml" title="ATOM Feed" href="{{ get_url(path=feed, trailing_slash=false, lang=lang) | safe }}" />
+                                {% endif -%}
+                            {% endfor -%}
+
+                                <svg id="rss-icon" xmlns="http://www.w3.org/2000/svg" width="22" height="22" viewBox="0 0 32 32" fill="none" stroke="{{rss_icon_color}}" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-rss">
+                                <g transform="translate(0,5)">
+                                    <path d="M4 11a9 9 0 0 1 9 9"></path>
+                                    <path d="M4 4a16 16 0 0 1 16 16"></path>
+                                    <circle cx="5" cy="19" r="1"></circle>
+                                </g>
+                                </svg>
+                            </a>
+                        {% endif -%}
+
                     {%- else -%}
-                        <a href="{{ item.url | replace(from="$BASE_URL", to=config.base_url) | safe }}">{{ item.name | safe }}</a>
+                        {%- if item.newtab -%}
+                            <a href="{{ item.url | replace(from="$BASE_URL", to=config.base_url) | safe }}" target="_blank" rel="noopener noreferrer">{{ item.name | safe }}</a>
+                        {%- else -%}
+                            <a href="{{ item.url | replace(from="$BASE_URL", to=config.base_url) | safe }}">{{ item.name | safe }}</a>
+                        {%- endif -%}
                     {%- endif -%}
+
                 </li>
             {% endfor -%}
             </ul>