-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add entry documenting RSS icon settings
- Loading branch information
vvzen
committed
Jun 8, 2024
1 parent
2c4cf6f
commit f1b4c1d
Showing
1 changed file
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|