haunt/README.md

55 lines
1.2 KiB
Markdown
Raw Normal View History

2015-01-05 02:02:16 +01:00
Haunt
=====
About
-----
Haunt is a static site generator written in Guile Scheme. It's
simple, functional, and extensible.
2015-01-05 02:02:16 +01:00
Features
--------
* Easy blog and Atom feed generation
* Supports any markup language that can be parsed to SXML
2015-01-05 02:02:16 +01:00
* Simple development server
* Purely functional build process
* User extensible
Example Configuration
---------------------
```
(use-modules (haunt site)
(haunt reader)
(haunt builder blog)
(haunt builder atom)
(srfi srfi-19))
(site #:title "Built with Guile"
#:domain "dthompson.us"
#:default-metadata
'((author . "David Thompson")
(email . "davet@gnu.org")
;; If I'm careless and forget a date, use the UNIX epoch.
(date . (make-date 0 0 0 0 1 1 1970)))
#:readers (list sxml-reader html-reader)
#:builders (list (blog)
(atom-feed)
(atom-feeds-by-tag)))
```
Usage
-----
Write a configuration file named `haunt.scm`. Add your posts to a
directory named `posts`. Then run `haunt build`!
To view your creation, run `haunt serve` and browse to
`localhost:8080`.
2015-01-05 02:02:16 +01:00
License
-------
GNU GPLv3 or later