Skip to content

Commit

Permalink
docs: Add entry documenting RSS icon settings
Browse files Browse the repository at this point in the history
  • Loading branch information
vvzen committed Jun 9, 2024
1 parent 6181259 commit c84d03c
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,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_feed = true
author = "[email protected]"

# Use `rss.xml` for RSS feeds and `atom.xml` for ATOM.
feed_filename = "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
Expand Down

0 comments on commit c84d03c

Please sign in to comment.