summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2023-12-28 08:42:43 -0500
committerDavid Thompson <dthompson2@worcester.edu>2023-12-28 08:50:36 -0500
commitd96ff37148ddb73291a5dbad6bbc43e05afac22b (patch)
tree038c05c8afb11e58f8afdf4e02f975f7f099e5ef /doc
parent1997825c1f14d7e5215b60f4b8b0060461ebbbbe (diff)
Document RSS builder.
Diffstat (limited to 'doc')
-rw-r--r--doc/haunt.texi36
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/haunt.texi b/doc/haunt.texi
index 9ba21ed..6f9d226 100644
--- a/doc/haunt.texi
+++ b/doc/haunt.texi
@@ -820,6 +820,7 @@ specification of Markdown, learn more about CommomMark
* Static Assets:: Images, CSS, JavaScript, etc.
* Blog:: Dear diary...
* Atom:: Atom feeds.
+* RSS:: RSS feeds.
@end menu
Builders are procedures that return one or more artifacts
@@ -982,6 +983,41 @@ prefix and post prefix. @xref{Blog} for more information.
@end deffn
+@node RSS
+@subsection RSS
+
+@example
+(use-modules (haunt builder rss))
+@end example
+
+@deffn {Procedure} rss-feed [#:file-name "rss-feed.xml"] [#:subtitle "Recent Posts"] @
+ [#:filter posts/reverse-chronological] @
+ [#:max-entries 20] [#:blog-prefix ""]
+Return a builder procedure that renders a list of posts as an RSS
+feed. All arguments are optional:
+
+@table @var
+
+@item file-name
+The page file name.
+
+@item subtitle
+The feed subtitle.
+
+@item filter
+The procedure called to manipulate the posts list before rendering.
+
+@item max-entries
+The maximum number of posts to render in the feed.
+
+@item blog-prefix
+The prefix for all post URLs, which is the combination of the blog's
+prefix and post prefix. @xref{Blog} for more information.
+
+@end table
+
+@end deffn
+
@node Publishers
@section Publishers