summaryrefslogtreecommitdiff
path: root/doc/haunt.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/haunt.texi')
-rw-r--r--doc/haunt.texi12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/haunt.texi b/doc/haunt.texi
index cfeff16..178565a 100644
--- a/doc/haunt.texi
+++ b/doc/haunt.texi
@@ -851,8 +851,8 @@ output directory. By default, @var{dest} is @var{directory}.
(use-modules (haunt builder blog))
@end example
-@deffn {Procedure} theme [#:name #:layout #:post-template #:collection-template @
- #:pagination-template]
+@deffn {Procedure} theme [#:name "Untitled"] [#:layout] [#:post-template] @
+ [#:collection-template] [#:pagination-template]
Create a new theme named @var{name}.
The procedure @var{layout} accepts three arguments: a site, a page
@@ -880,10 +880,14 @@ links.
Return @code{#t} if @var{object} is a theme object.
@end deffn
-@deffn {Procedure} blog [#:theme #:prefix #:collections #:posts-per-page]
+@deffn {Procedure} blog [#:theme] [#:prefix] [#:post-prefix] @
+ [#:collections `(("Recent Posts" "index.html" ,posts/reverse-chronological))] @
+ [#:posts-per-page]
+
Create a builder procedure that transforms a list of posts into pages
decorated by @var{theme}, a theme object, whose URLs start with
-@var{prefix}.
+@var{prefix}. Post pages may be nested deeper in the file hierarchy
+than collection pages by specifying the @var{post-prefix} argument.
Additionally, this builder creates pages that aggregate previews of
many posts corresponding to what is specified in the list