From d3a9ba4ebea136fae676911148509ec3f729abbc Mon Sep 17 00:00:00 2001 From: David Thompson Date: Sun, 24 Apr 2016 15:26:44 -0400 Subject: website: Add copy of HTML manual. --- website/manual/Sites.html | 177 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 177 insertions(+) create mode 100644 website/manual/Sites.html (limited to 'website/manual/Sites.html') diff --git a/website/manual/Sites.html b/website/manual/Sites.html new file mode 100644 index 0000000..bae2e72 --- /dev/null +++ b/website/manual/Sites.html @@ -0,0 +1,177 @@ + + + + + +Haunt Reference Manual: Sites + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Up: Programming Interface   [Contents][Index]

+
+
+ +

5.1 Sites

+ +
+
(use-modules (haunt site))
+
+ +

A site object defines all of the properties for a Haunt website: The +site name, domain name, where blog posts are found, what post formats +are understood, which procedures are used to build the site, where the +output files are written to, etc. +

+
+
Scheme Procedure: site [#:title "This Place is Haunted"] [#:domain "example.com"] [#:posts-directory "posts"] [#:file-filter default-file-filter] [#:build-directory "site"] [#:default-metadata '()] [#:make-slug post-slug] [#:readers '()] [#:builders '()]
+

Create a new site object. All arguments are optional: +

+
+
title
+

The name of the site. +

+
+
posts-directory
+

The directory where posts are found. +

+
+
file-filter
+

A predicate procedure that returns #f when a post file should +be ignored, and #t otherwise. Emacs temporary files are +ignored by default. +

+
+
build-directory
+

The directory that generated pages are stored in. +

+
+
default-metadata
+

An alist of arbitrary default metadata for posts whose keys are +symbols. +

+
+
make-slug
+

A procedure generating a file name slug from a post. +

+
+
readers
+

A list of reader objects for processing posts. +

+
+
builders
+

A list of procedures for building pages from posts. +

+
+
+ +
+ +
+
Scheme Procedure: site? obj
+

Return #t if obj is a site object. +

+ +
+
Scheme Procedure: site-title site
+

Return the title of site. +

+ +
+
Scheme Procedure: site-domain site
+

Return the domain of site. +

+ +
+
Scheme Procedure: site-posts-directory site
+

Return the posts directory for site. +

+ +
+
Scheme Procedure: site-file-filter site
+

Return the file filter procedure for site. +

+ +
+
Scheme Procedure: site-build-directory site
+

Return the build directory of site. +

+ +
+
Scheme Procedure: site-make-slug site
+

Return the slug constructor for site. +

+ +
+
Scheme Procedure: site-readers site
+

Return the list of reader procedures for site. +

+ +
+
Scheme Procedure: site-builders site
+

Return the list of builder procedures for site. +

+ +
+
+

+Next: , Up: Programming Interface   [Contents][Index]

+
+ + + + + -- cgit v1.2.3