Compare commits

...

10 commits

Author SHA1 Message Date
Valerio Viperino 289ce25b53
Merge 8fc4001c4f into 7f630a4e31 2024-08-18 21:53:32 +00:00
Valerio Viperino 8fc4001c4f feat: Compatibility with zola >=0.19
NOTE: This breaks compat with previous previous versions since Zola made a
breaking change in 0.19 and imho it's not worth trying to support previous
versions too.
2024-08-18 14:51:34 -07:00
Valerio Viperino 5017bf67a0 docs: Add License for Feather Icons 2024-08-18 14:39:37 -07:00
vvzen 640d3feb77 docs: Add entry documenting RSS icon settings 2024-08-18 14:36:57 -07:00
vvzen 6c8a4b3a87 feat: Initial support for custom rss icon color
At some point this might follow the same logic used by `accent_color`
and `background_color`, for consistency.
2024-08-18 14:36:57 -07:00
vvzen 2bb4eb9ee2 feat: Change RSS icon, do not prepend {{name}}
There's some css rules for which prepending the name of the menu item as
set in the config causes the <a> element to appear shifted down compared
to the other <a> elements of the menu. I might have a look later, but
for now this enables only the appeareance of the RSS icon, discarding
entirely the name of the link.
2024-08-18 14:36:57 -07:00
vvzen ec0b182d0f feat: Support atom rss too 2024-08-18 14:36:57 -07:00
vvzen c5f29a69ec chore: Newlines 2024-08-18 14:36:57 -07:00
vvzen 3d03d06460 feat: Also gate on config.generate_feed 2024-08-18 14:36:57 -07:00
vvzen b69654d06c feat: Show RSS icon if config enables it
This adds support for showing a tiny RSS svg badge in the top menu in
case the user added a menu_item that looks like this:
`{name = "", url = "$BASE_URL/$FEED_FILENAME"}`

This also requires that the user has a config.toml that contains the
following entries:

generate_feed = true
feed_filename = "rss.xml"
author = "your name here"
2024-08-18 14:36:57 -07:00
4 changed files with 96 additions and 3 deletions

21
LICENSE-Feather.md Normal file
View file

@ -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.

View file

@ -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

View file

@ -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"

View file

@ -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>