diff --git a/LICENSE-Feather.md b/LICENSE-Feather.md new file mode 100644 index 0000000..1f4f433 --- /dev/null +++ b/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. diff --git a/README.md b/README.md index b8fc4b7..679f3c3 100644 --- a/README.md +++ b/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 diff --git a/config.toml b/config.toml index b03451a..4135faf 100644 --- a/config.toml +++ b/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" diff --git a/templates/macros/menu.html b/templates/macros/menu.html index 090388f..5d128e5 100644 --- a/templates/macros/menu.html +++ b/templates/macros/menu.html @@ -38,11 +38,45 @@